Package org.eclipse.pde.ui.templates
Class PluginReference
- java.lang.Object
- 
- org.eclipse.pde.ui.templates.PluginReference
 
- 
- All Implemented Interfaces:
- IIdentifiable,- IMatchRules,- IPluginReference
 
 public class PluginReference extends Object implements IPluginReference Implementation of the IPluginReferenceThis class may be instantiated. This class is not intended to be sub-classed by clients. - Since:
- 3.4
- See Also:
- IPluginReference
- Restriction:
- This class is not intended to be sub-classed by clients.
 
- 
- 
Field Summary- 
Fields inherited from interface org.eclipse.pde.core.IIdentifiableP_ID
 - 
Fields inherited from interface org.eclipse.pde.core.plugin.IMatchRulesCOMPATIBLE, EQUIVALENT, GREATER_OR_EQUAL, NONE, PERFECT, PREFIX, RULE_COMPATIBLE, RULE_EQUIVALENT, RULE_GREATER_OR_EQUAL, RULE_NAME_TABLE, RULE_PERFECT, RULE_PREFIX
 - 
Fields inherited from interface org.eclipse.pde.core.plugin.IPluginReferenceP_MATCH, P_VERSION
 
- 
 - 
Constructor SummaryConstructors Constructor Description PluginReference(String id)Constructs a plug-in reference to be used in the PDE template frameworkPluginReference(String id, String version, int match)Constructs a plug-in reference to be used in the PDE template framework
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object object)StringgetId()Returns a unique id of this object.intgetMatch()Returns the required match for the imported plug-in.StringgetVersion()Returns the required version of the plug-in.inthashCode()voidsetId(String id)Sets the id of this IIdentifiable to the provided value.voidsetMatch(int match)Sets the match type for the require plug-in.voidsetVersion(String version)Sets the desired version of the required plug-in.
 
- 
- 
- 
Constructor Detail- 
PluginReferencepublic PluginReference(String id) Constructs a plug-in reference to be used in the PDE template framework- Parameters:
- id- the id of the plug-in
- Since:
- 3.9
- See Also:
- PluginReference(String id, String version, int match)
 
 - 
PluginReferencepublic PluginReference(String id, String version, int match) Constructs a plug-in reference to be used in the PDE template framework- Parameters:
- id- the id of the plug-in
- version- the version of the plug-in
- match- the match rule for the plug-in- IMatchRules
 
 
- 
 - 
Method Detail- 
getMatchpublic int getMatch() Description copied from interface:IPluginReferenceReturns the required match for the imported plug-in. The choices are defined in IMatchRules interface.- Specified by:
- getMatchin interface- IPluginReference
- Returns:
- the desired type of the import plug-in match
- See Also:
- IMatchRules
 
 - 
getVersionpublic String getVersion() Description copied from interface:IPluginReferenceReturns the required version of the plug-in.- Specified by:
- getVersionin interface- IPluginReference
- Returns:
- required version or null if not set
 
 - 
setMatchpublic void setMatch(int match) throws CoreExceptionDescription copied from interface:IPluginReferenceSets the match type for the require plug-in. This method will throw a CoreException if the model is not editable.- Specified by:
- setMatchin interface- IPluginReference
- Parameters:
- match- the desired match type
- Throws:
- CoreException- if the model is not editable
- See Also:
- IMatchRules
 
 - 
setVersionpublic void setVersion(String version) throws CoreException Description copied from interface:IPluginReferenceSets the desired version of the required plug-in. This method will throw a CoreException if the model is not editable.- Specified by:
- setVersionin interface- IPluginReference
- Parameters:
- version- the required import plug-in version
- Throws:
- CoreException- if the model is not editable
 
 - 
getIdpublic String getId() Description copied from interface:IIdentifiableReturns a unique id of this object.- Specified by:
- getIdin interface- IIdentifiable
- Returns:
- the id of this object
 
 - 
setIdpublic void setId(String id) throws CoreException Description copied from interface:IIdentifiableSets the id of this IIdentifiable to the provided value.- Specified by:
- setIdin interface- IIdentifiable
- Parameters:
- id- a new id of this object
- Throws:
- CoreException- If object is not editable.
 
 
- 
 
-