|
Faceted Project Framework Version 1.3 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface IProjectFacetVersion
Contains metadata that describes a specific version of a project facet. This interface is not intended to be implemented by by clients.
| Method Summary | |
|---|---|
boolean |
conflictsWith(IProjectFacetVersion fv)
|
Object |
createActionConfig(IFacetedProject.Action.Type type,
String pjname)
Deprecated. this method will not behave correctly in presence of multiple action definitions of the same type as can be the case with VERSION_CHANGE actions; instead use IActionDefinition.createConfigObject() |
IActionDefinition |
getActionDefinition(Set<IProjectFacetVersion> base,
IFacetedProject.Action.Type type)
Returns the action definition corresponding to a particular action type over this project facet version. |
Set<IActionDefinition> |
getActionDefinitions()
Returns all of the action definitions for this project facet version. |
Set<IActionDefinition> |
getActionDefinitions(IFacetedProject.Action.Type type)
Returns the action definitions corresponding to a particular action type over this project facet version. |
IConstraint |
getConstraint()
Returns the constraint that has to be satisfied prior to installing this project facet. |
String |
getPluginId()
Returns the id of the plugin that defines this project facet version. |
IProjectFacet |
getProjectFacet()
Returns the project facet descriptor. |
Map<String,Object> |
getProperties()
Returns the properties that specify additional information regarding this facet version. |
Object |
getProperty(String name)
Returns the property value corresponding to the provided name. |
String |
getVersionString()
Returns the version string. |
boolean |
isSameActionConfig(IFacetedProject.Action.Type type,
IProjectFacetVersion fv)
Deprecated. this method will not behave correctly in presence of multiple action definitions of the same type as can be the case with VERSION_CHANGE actions; instead compare appropriate IActionDefinition objects directly |
boolean |
isValidFor(Set<IProjectFacet> fixed)
Determines whether this facet version is valid for projects that have the provided set of fixed facets. |
boolean |
supports(IFacetedProject.Action.Type type)
Deprecated. use supports( Set, IFacetedProject.Action.Type) instead |
boolean |
supports(Set<IProjectFacetVersion> base,
IFacetedProject.Action.Type type)
Determines whether this project facet version supports a particular action type. |
| Method Detail |
|---|
IProjectFacet getProjectFacet()
String getVersionString()
getVersionString in interface IVersionString getPluginId()
null if this version is not defined.
nullIConstraint getConstraint()
boolean supports(Set<IProjectFacetVersion> base,
IFacetedProject.Action.Type type)
Action.Type.UNINSTALL.
base - the set of facets currently installed in the project that
the desired action type would be executed againsttype - action type
true if and only if this project facet supports the
provided action typeboolean supports(IFacetedProject.Action.Type type)
supports( Set, IFacetedProject.Action.Type) instead
Action.Type.UNINSTALL.
type - action type
true if this project facet supports the provided
action type, false otherwiseSet<IActionDefinition> getActionDefinitions()
Set<IActionDefinition> getActionDefinitions(IFacetedProject.Action.Type type)
INSTALL and
UNINSTALL action types, this method will return a set of
length 0 or 1. For VERSION_CHANGE action type, the returned
set may contain more than one item as there may exist multiple action
definitions for converting from various versions.
type - action type
IActionDefinition getActionDefinition(Set<IProjectFacetVersion> base,
IFacetedProject.Action.Type type)
throws CoreException
supports( Set, IFacetedProject.Action.Type )
method can be used to check whether the action is supported prior to
calling this method.
base - the set of facets currently installed in the project that
the desired action type would be executed againsttype - action type
CoreException - if this project facet version does not support the
provided action type
Object createActionConfig(IFacetedProject.Action.Type type,
String pjname)
throws CoreException
null if the action
requires no config.
type - the type of the action.pjname - the name of the project that this action will be executed
on
null
CoreException - if this project facet version does not support the
specified action type or if failed while creating the action config
object
boolean isSameActionConfig(IFacetedProject.Action.Type type,
IProjectFacetVersion fv)
throws CoreException
CoreExceptionboolean isValidFor(Set<IProjectFacet> fixed)
fixed - the set of fixed facets
true if this facet version is valid for the projects
that have the provided set of fixed facetsboolean conflictsWith(IProjectFacetVersion fv)
Map<String,Object> getProperties()
Object getProperty(String name)
name - the name of the property
|
Faceted Project Framework Version 1.3 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||