|
Faceted Project Framework Version 1.3 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.wst.common.project.facet.core.FacetedProjectFramework
public final class FacetedProjectFramework
| Field Summary | |
|---|---|
static String |
DEFAULT_CONFIGURATION_PRESET_ID
The id of a built-in preset that provides default configuration. |
static String |
PLUGIN_ID
|
| Method Summary | |
|---|---|
static void |
addListener(IFacetedProjectFrameworkListener listener,
IFacetedProjectFrameworkEvent.Type... types)
|
static 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. |
static IFacetedProjectWorkingCopy |
createNewProject()
|
static org.osgi.service.prefs.Preferences |
getPreferences(IProjectFacet facet)
Returns the global preferences store for the specified facet. |
static boolean |
hasProjectFacet(IProject project,
String fid)
Determines whether the specified project facet is installed in the provided project. |
static boolean |
hasProjectFacet(IProject project,
String fid,
String vexpr)
Determines whether the specified project facet is installed in the provided project. |
static boolean |
isFacetedProject(IProject project)
Determines whether the specified project is faceted. |
static void |
removeListener(IFacetedProjectFrameworkListener listener)
|
static void |
removeListener(IFacetedProjectListener listener)
Removes the faceted project listener that was previously registered using the addListener(IFacetedProjectListener,IFacetedProjectEvent.Type[]) method. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final String PLUGIN_ID
public static final String DEFAULT_CONFIGURATION_PRESET_ID
IRuntime.getDefaultFacets(Set).IProjectFacet.getDefaultVersion().
| Method Detail |
|---|
public static IFacetedProjectWorkingCopy createNewProject()
public static boolean isFacetedProject(IProject project)
throws CoreException
false if the project is not accessible.
project - the project to check
true if the project is faceted
CoreException - if failed while reading project metadata
public static boolean hasProjectFacet(IProject project,
String fid)
throws CoreException
Determines whether the specified project facet is installed in the
provided project. Returns false if the project is not
accessible, the project is not faceted or the facet id is unrecognized.
This method is explicitly designed to avoid activation of the Faceted
Project Framework if the project is not faceted. For the code that
operates in the context where it can be assumed that the framework has
started already, better performance can be achieved by storing
IProjectFacet and IProjectFacetVersion instances using the
singleton pattern and using the
IFacetedProjectBase.hasProjectFacet(IProjectFacet) or
IFacetedProjectBase.hasProjectFacet(IProjectFacetVersion) methods.
This method is equivalent to calling
hasProjectFacet(IProject,String,String) with null
version expression parameter.
project - the project to check for the facet presencefid - the project facet id
true if specified project has the given facet
CoreException - if failed while reading faceted project metadata
public static boolean hasProjectFacet(IProject project,
String fid,
String vexpr)
throws CoreException
Determines whether the specified project facet is installed in the
provided project. Returns false if the project is not
accessible or the project is not faceted. Works even if the facet or
the version that is being checked is not defined.
This method is explicitly designed to avoid activation of the Faceted
Project Framework if the project is not faceted. For the code that
operates in the context where it can be assumed that the framework has
started already, better performance can be achieved by storing
IProjectFacet and IProjectFacetVersion instances using the
singleton pattern and using the
IFacetedProjectBase.hasProjectFacet(IProjectFacet) or
IFacetedProjectBase.hasProjectFacet(IProjectFacetVersion) methods.
project - the project to check for the facet presencefid - the project facet idvexpr - the version match expression, or null to
match any version
true if specified project has the given facet
CoreException - if failed while reading faceted project metadata;
if the version expression is invalid
public static void 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),
IFacetedProjectBase.addListener(IFacetedProjectListener,IFacetedProjectEvent.Type[]),
IFacetedProject.removeListener(IFacetedProjectListener)
public static void addListener(IFacetedProjectFrameworkListener listener,
IFacetedProjectFrameworkEvent.Type... types)
public static 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 nulladdListener(IFacetedProjectListener,IFacetedProjectEvent.Type[]),
IFacetedProjectBase.addListener(IFacetedProjectListener,IFacetedProjectEvent.Type[]),
IFacetedProject.removeListener(IFacetedProjectListener)public static void removeListener(IFacetedProjectFrameworkListener listener)
public static org.osgi.service.prefs.Preferences getPreferences(IProjectFacet facet)
throws org.osgi.service.prefs.BackingStoreException
facet - project facet
org.osgi.service.prefs.BackingStoreException - if failed while reading from the backing store
|
Faceted Project Framework Version 1.3 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||