|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
Represents a component as defined by the .wtpmodules file.
A component is a container of virtual resources which has other features that describe the component including:
getComponentTypeId()
| Field Summary | |
static int |
BINARY
Type constant (bit mask value 1) which identifies component binary status. |
static org.eclipse.core.runtime.IPath |
ROOT
|
| Method Summary | |
void |
create(int updateFlags,
org.eclipse.core.runtime.IProgressMonitor aMonitor)
Create the underlying model elements if they do not already exist. |
boolean |
exists()
Returns whether this component is backed by an accessible Component. |
IVirtualComponent |
getComponent()
Returns reference to itself. |
ComponentHandle |
getComponentHandle()
The componentHandle is a handy way to pass the identity of this component instance |
java.lang.String |
getComponentTypeId()
The componentTypeId is used to understand how this component should be edited and deployed. |
java.util.Properties |
getMetaProperties()
MetaProperties are String-based name-value pairs that include information about this component that may be relevant to clients or the way that clients edit or deploy components. |
org.eclipse.core.runtime.IPath[] |
getMetaResources()
MetaResources provide a loose mechanism for components that would like to list off the metadata-resources available in the component which can aid or expedite searching for this resources. |
java.lang.String |
getName()
The name of the component must be unique within its enclosing project. |
org.eclipse.core.resources.IProject |
getProject()
Returns the project which contains the component. |
IVirtualReference |
getReference(java.lang.String aComponentName)
Virtual components may reference other virtual components to build logical dependency trees. |
IVirtualReference[] |
getReferences()
Virtual components may reference other virtual components to build logical dependency trees. |
IVirtualComponent[] |
getReferencingComponents()
Returns the components which reference this component. |
IVirtualFolder |
getRootFolder()
Returns a handle to the root folder. |
java.lang.String |
getVersion()
The version associated with the component. |
boolean |
isBinary()
Returns true if this component is of binary type |
void |
setComponentTypeId(java.lang.String aComponentTypeId)
The componentTypeId is used to understand how this component should be edited and deployed. |
void |
setMetaResources(org.eclipse.core.runtime.IPath[] theMetaResourcePaths)
MetaResources provide a loose mechanism for components that would like to list off the metadata-resources available in the component which can aid or expedite searching for this resources. |
void |
setReferences(IVirtualReference[] theReferences)
Virtual components may reference other virtual components to build logical dependency trees. |
| Field Detail |
public static final org.eclipse.core.runtime.IPath ROOT
public static final int BINARY
| Method Detail |
public java.lang.String getName()
public java.lang.String getComponentTypeId()
public ComponentHandle getComponentHandle()
public IVirtualComponent getComponent()
public void setComponentTypeId(java.lang.String aComponentTypeId)
aComponentTypeId - A value which is either standard for a common component type or client-defined for
a custom component typepublic java.util.Properties getMetaProperties()
public org.eclipse.core.runtime.IPath[] getMetaResources()
Clients are not required to get or set the MetaResources for a component.
setMetaResources(IPath[])public void setMetaResources(org.eclipse.core.runtime.IPath[] theMetaResourcePaths)
Clients are not required to get or set the MetaResources for a component. The existing MetaResources will be overwritten after the call to this method.
theMetaResourcePaths - An array of paths that will become the new MetaResource array.public IVirtualReference[] getReferences()
Each virtual reference will indicate how the content of the reference will be absorbed by this component. Each virtual reference will always specify an enclosing component that will be this component.
public IVirtualReference getReference(java.lang.String aComponentName)
Each virtual reference will indicate how the content of the reference will be absorbed by this component. Each virtual reference will always specify an enclosing component that will be this component.
public void setReferences(IVirtualReference[] theReferences)
Each virtual reference will indicate how the content of the reference will be absorbed by this component. Each virtual reference will always specify an enclosing component that will be this component. Any references specified in the array which do not specify an enclosing component that matches this component will be modified to specify this virtual component.
Existing virtual references will be overwritten when this method is called.
theReferences - A by-value copy of the virtual reference arraypublic java.lang.String getVersion()
public boolean isBinary()
public void create(int updateFlags,
org.eclipse.core.runtime.IProgressMonitor aMonitor)
throws org.eclipse.core.runtime.CoreException
updateFlags - Any of IVirtualResource or IResource update flags. If a
resource must be created, the updateFlags will be supplied to the
resource creation operation.aMonitor -
org.eclipse.core.runtime.CoreExceptionpublic IVirtualFolder getRootFolder()
This is a resource handle operation; neither the container nor the result need exist in the workspace. The validation check on the resource name/path is not done when the resource handle is constructed; rather, it is done automatically as the resource is created.
#getFile(String)public org.eclipse.core.resources.IProject getProject()
The name of the project may not (and most likely will not) be referenced in the runtime path of this virtual path, but will be referenced by the workspace-relative path.
This is a resource handle operation; neither the resource nor the resulting project need exist.
public boolean exists()
public IVirtualComponent[] getReferencingComponents()
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||