Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Eclipse Platform Release 3.0
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.eclipse.update.core.model
Class PluginEntryModel

    java.lang.Object
      org.eclipse.core.runtime.PlatformObject
          org.eclipse.update.core.model.ModelObject
              org.eclipse.update.core.model.ContentEntryModel
                  org.eclipse.update.core.model.PluginEntryModel

All Implemented Interfaces:
  IAdaptable

Direct Known Subclasses:
  PluginEntry

public class PluginEntryModel
extends ContentEntryModel

Plug-in entry model object.

This class may be instantiated or subclassed by clients. However, in most cases clients should instead instantiate or subclass the provided concrete implementation of this model.

Note: This class/interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

Since:
  2.0
See Also:
  `PluginEntry`

Field Summary

Fields inherited from class org.eclipse.update.core.model.ContentEntryModel
`UNKNOWN_SIZE`

Constructor Summary
`PluginEntryModel()` Creates a uninitialized plug-in entry model object.

Method Summary
`boolean` | `equals(Object obj)` Compares two plug-in models for equality
`String` | `getPluginIdentifier()` Returns the plug-in identifier for this entry.
`String` | `getPluginVersion()` Returns the plug-in version for this entry.
`boolean` | `isFragment()` Indicates whether the entry describes a full plug-in, or a plug-in fragment.
`void` | `isFragment(boolean isFragment)` Indicates whether this entry represents a fragment or plug-in.
`boolean` | `isUnpack()`
`void` | `setPluginIdentifier(String pluginId)` Sets the entry plug-in identifier.
`void` | `setPluginVersion(String pluginVersion)` Sets the entry plug-in version.
`void` | `setUnpack(boolean unpack)`
`String` | `toString()`

Methods inherited from class org.eclipse.update.core.model.ContentEntryModel
`getDownloadSize, getInstallSize, getNL, getOS, getOSArch, getWS, setArch, setDownloadSize, setInstallSize, setNL, setOS, setWS`

Methods inherited from class org.eclipse.update.core.model.ModelObject
`arrayTypeFor, arrayTypeFor, assertIsWriteable, getPropertyName, getResourceBundle, isReadOnly, markListReferenceReadOnly, markReadOnly, markReferenceReadOnly, resolve, resolveListReference, resolveNLString, resolveReference, resolveURL`

Methods inherited from class org.eclipse.core.runtime.PlatformObject
`getAdapter`

Methods inherited from class java.lang.Object
`clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

### PluginEntryModel

    public PluginEntryModel()

  Creates a uninitialized plug-in entry model object.

Since:
  2.0

Method Detail

### equals

    public boolean equals(Object obj)

  Compares two plug-in models for equality

  Parameters:
    `obj` - other model to compare to
  Returns:
    `true` if the models are equal, `false` otherwise
  Since:
    2.0

### getPluginIdentifier

    public String getPluginIdentifier()

  Returns the plug-in identifier for this entry.

  Returns:
    the plug-in identifier, or `null`
  Since:
    2.0

### getPluginVersion

    public String getPluginVersion()

  Returns the plug-in version for this entry.

  Returns:
    the plug-in version, or `null`
  Since:
    2.0

### isFragment

    public boolean isFragment()

  Indicates whether the entry describes a full plug-in, or a plug-in fragment.

  Returns:
    `true` if the entry is a plug-in fragment, `false` if the entry is a plug-in
  Since:
    2.0

### setPluginIdentifier

    public void setPluginIdentifier(String pluginId)

  Sets the entry plug-in identifier. Throws a runtime exception if this object is marked read-only.

  Parameters:
    `pluginId` - the entry identifier.
  Since:
    2.0

### setPluginVersion

    public void setPluginVersion(String pluginVersion)

  Sets the entry plug-in version. Throws a runtime exception if this object is marked read-only.

  Parameters:
    `pluginVersion` - the entry version.
  Since:
    2.0

### isFragment

    public void isFragment(boolean isFragment)

  Indicates whether this entry represents a fragment or plug-in. Throws a runtime exception if this object is marked read-only.

  Parameters:
    `isFragment` - fragment setting
  Since:
    2.0

### isUnpack

    public boolean isUnpack()

  Returns:
    Indicates whether plugin should be unpacked during installation or can run from a jar
  Since:
    3.0

### setUnpack

    public void setUnpack(boolean unpack)

  Parameters:
    `unpack` - Sets whether plugin should be unpacked during installation or can run from a jar
  Since:
    3.0

### toString

    public String toString()

  See Also:
    `Object.toString()`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Eclipse Platform Release 3.0
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2004. All rights reserved.