org.eclipse.core.runtime.model
Class PluginFragmentModel

java.lang.Object
  |
  +--org.eclipse.core.runtime.model.PluginModelObject
        |
        +--org.eclipse.core.runtime.model.PluginModel
              |
              +--org.eclipse.core.runtime.model.PluginFragmentModel

public class PluginFragmentModel

extends PluginModel

An object which represents the user-defined contents of a plug-in fragment in a plug-in manifest.

This class may be instantiated, or further subclassed.

Field Summary

static byte	FRAGMENT_MATCH_COMPATIBLE
static byte	FRAGMENT_MATCH_EQUIVALENT
static byte	FRAGMENT_MATCH_GREATER_OR_EQUAL
static byte	FRAGMENT_MATCH_PERFECT
static byte	FRAGMENT_MATCH_UNSPECIFIED

Constructor Summary

PluginFragmentModel()
Creates a new plug-in descriptor model in which all fields are null.

Method Summary

byte	getMatch() Returns a byte code indicating the type of match this fragment requires when trying to find its associated plugin.
String	getPlugin() Returns the fully qualified name of the plug-in for which this is a fragment
String	getPluginId() Returns the unique identifier of the plug-in related to this model or null.
String	getPluginVersion() Returns the version name of the plug-in for which this is a fragment.
void	setMatch(byte value) Sets the type of match this fragment requires when trying to find its associated plugin.
void	setPlugin(String value) Sets the fully qualified name of the plug-in for which this is a fragment This object must not be read-only.
void	setPluginVersion(String value) Sets the version name of the plug-in for which this is a fragment.

Methods inherited from class org.eclipse.core.runtime.model.PluginModel

getDeclaredExtensionPoints, getDeclaredExtensions, getId, getLocation, getProviderName, getRegistry, getRequires, getRuntime, getVersion, markReadOnly, setDeclaredExtensionPoints, setDeclaredExtensions, setId, setLocation, setProviderName, setRegistry, setRequires, setRuntime, setVersion

Methods inherited from class org.eclipse.core.runtime.model.PluginModelObject

assertIsWriteable, getName, isReadOnly, setName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FRAGMENT_MATCH_UNSPECIFIED

public static final byte FRAGMENT_MATCH_UNSPECIFIED

See Also:

Constant Field Values

FRAGMENT_MATCH_PERFECT

public static final byte FRAGMENT_MATCH_PERFECT

See Also:

Constant Field Values

FRAGMENT_MATCH_EQUIVALENT

public static final byte FRAGMENT_MATCH_EQUIVALENT

See Also:

Constant Field Values

FRAGMENT_MATCH_COMPATIBLE

public static final byte FRAGMENT_MATCH_COMPATIBLE

See Also:

Constant Field Values

FRAGMENT_MATCH_GREATER_OR_EQUAL

public static final byte FRAGMENT_MATCH_GREATER_OR_EQUAL

See Also:

Constant Field Values

Constructor Detail

PluginFragmentModel

public PluginFragmentModel()

Creates a new plug-in descriptor model in which all fields are null.

Method Detail

getMatch

public byte getMatch()

Returns a byte code indicating the type of match this fragment requires when trying to find its associated plugin. The byte code can be any one of the following: FRAGMENT_MATCH_UNSPECIFIED initial value FRAGMENT_MATCH_PERFECT perfectly equal match FRAGMENT_MATCH_EQUIVALENT equivalent match FRAGMENT_MATCH_COMPATIBLE compatible match FRAGMENT_MATCH_GREATER_OR_EQUAL greater than or equal to match

Returns:

a byte code indicating the type of match this fragment requires

Since:

2.0

getPlugin

public String getPlugin()

Returns the fully qualified name of the plug-in for which this is a fragment

Returns:

the name of this fragment's plug-in or null.

getPluginId

public String getPluginId()

Returns the unique identifier of the plug-in related to this model or null. This identifier is a non-empty string and is unique within the plug-in registry.

Specified by:

getPluginId in class PluginModel

Returns:

the unique identifier of the plug-in related to this model (e.g. "com.example") or null.

getPluginVersion

public String getPluginVersion()

Returns the version name of the plug-in for which this is a fragment.

Returns:

the version name of this fragment's plug-in or null

setMatch

public void setMatch(byte value)

Sets the type of match this fragment requires when trying to find its associated plugin. The value parameter may be any one of the following: FRAGMENT_MATCH_UNSPECIFIED initial value FRAGMENT_MATCH_PERFECT perfectly equal match FRAGMENT_MATCH_EQUIVALENT equivalent match FRAGMENT_MATCH_COMPATIBLE compatible match FRAGMENT_MATCH_GREATER_OR_EQUAL greater than or equal to match This object must not be read-only.

Parameters:

value - the type of match required with the associated plugin

Since:

2.0

setPlugin

public void setPlugin(String value)

Sets the fully qualified name of the plug-in for which this is a fragment This object must not be read-only.

Parameters:

value - the name of this fragment's plug-in. May be null.

setPluginVersion

public void setPluginVersion(String value)

Sets the version name of the plug-in for which this is a fragment. The given version number is canonicalized. This object must not be read-only.

Parameters:

value - the version name of this fragment's plug-in. May be null.