|
Faceted Project Framework Version 1.3 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IFacetedProjectBase
This interface is used for manipulating the set of facets installed on a
project. Use ProjectFacetsManager.create(IProject)
to get an instance
of this interface.
Field Summary | |
---|---|
static int |
PROBLEM_OTHER
|
static int |
PROBLEM_PROJECT_NAME
|
Method Summary | |
---|---|
void |
addListener(IFacetedProjectListener listener,
IFacetedProjectEvent.Type... types)
Adds a faceted project listener that will be notified when the selected events in the faceted project life cycle occur. |
Set<IProjectFacet> |
getFixedProjectFacets()
Returns the set of fixed project facets for this project. |
IRuntime |
getPrimaryRuntime()
Returns the primary target runtime for this project. |
IProject |
getProject()
|
Set<IProjectFacetVersion> |
getProjectFacets()
Returns the set of project facets currently installed on this project. |
IProjectFacetVersion |
getProjectFacetVersion(IProjectFacet f)
|
Set<IRuntime> |
getTargetedRuntimes()
Returns the set of all runtimes that this project is targeting. |
boolean |
hasProjectFacet(IProjectFacet f)
Determines whether any version of the specified project facet is installed on this project. |
boolean |
hasProjectFacet(IProjectFacetVersion fv)
Determines whether the specfied project facet version is installed on this project. |
boolean |
isFixedProjectFacet(IProjectFacet facet)
|
boolean |
isTargetable(IRuntime runtime)
Determines whether this project (in it's current state) can be targeted to the provided runtime. |
boolean |
isTargeted(IRuntime runtime)
Checks whether this project currently targets the specified runtime. |
void |
removeListener(IFacetedProjectListener listener)
Removes the faceted project listener that was previously registered using the addListener(IFacetedProjectListener,IFacetedProjectEvent.Type[]) method. |
IStatus |
validate()
Performs a variety of consistency checks over the faceted project. |
IStatus |
validate(IProgressMonitor monitor)
Performs a variety of consistency checks over the faceted project. |
Field Detail |
---|
static final int PROBLEM_PROJECT_NAME
static final int PROBLEM_OTHER
Method Detail |
---|
IProject getProject()
Set<IProjectFacet> getFixedProjectFacets()
boolean isFixedProjectFacet(IProjectFacet facet)
Set<IProjectFacetVersion> getProjectFacets()
IProjectFacetVersion getProjectFacetVersion(IProjectFacet f)
boolean hasProjectFacet(IProjectFacet f)
f
- the project facet descriptor
true
if any version of the specified project facet
is installed on this project, false
otherwiseboolean hasProjectFacet(IProjectFacetVersion fv)
fv
- the project facet version descriptor
true
if the specified project facet version is
installed on this project, false
otherwiseboolean isTargetable(IRuntime runtime)
runtime
- the runtime to check
true
if this project can target the provided runtime and
false
otherwiseboolean isTargeted(IRuntime runtime)
runtime
- the runtime to check
true
if this project currently targets the specified runtime and
false
otherwiseSet<IRuntime> getTargetedRuntimes()
Returns the set of all runtimes that this project is targeting. When a project targets a runtime, the set of facets that can be installed is limited to those supported by that runtime. When a project targets multiple runtimes, the set of applicable facets is limited to those supported by all targeted runtimes.
IRuntime getPrimaryRuntime()
Returns the primary target runtime for this project. There is always a primary runtime unless the list of target runtimes is empty.
null
IStatus validate(IProgressMonitor monitor)
monitor
- a progress monitor, or null
if progress
reporting and cancellation are not desired
IStatus.OK
if this
faceted project is valid, otherwise a status object indicating what is
wrong with itIStatus validate()
null
progress monitor.
IStatus.OK
if this
faceted project is valid, otherwise a status object indicating what is
wrong with itvoid addListener(IFacetedProjectListener listener, IFacetedProjectEvent.Type... types)
listener
- the faceted project listenertypes
- the types of the events to listen for
IllegalArgumentException
- if listener
parameter is null
or
the types
parameter is null
or empty.removeListener(IFacetedProjectListener)
,
FacetedProjectFramework.addListener(IFacetedProjectListener,IFacetedProjectEvent.Type[])
,
FacetedProjectFramework.removeListener(IFacetedProjectListener)
void removeListener(IFacetedProjectListener listener)
addListener(IFacetedProjectListener,IFacetedProjectEvent.Type[])
method. If the
specified listener is not present in the listener registry, this call will be ignored.
listener
- the faceted project listener
IllegalArgumentException
- if listener
parameter is null
addListener(IFacetedProjectListener,IFacetedProjectEvent.Type[])
,
FacetedProjectFramework.addListener(IFacetedProjectListener,IFacetedProjectEvent.Type[])
,
FacetedProjectFramework.removeListener(IFacetedProjectListener)
|
Faceted Project Framework Version 1.3 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |