|
IBM Rational Software Modeler Release 6.0 |
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
The ITypeAnalyzer interface is used to associate the type of a
physical resouce with an artifact type. This interface is not intended to
be implemented by clients.
| Field Summary | |
static String |
UNKNOWN_TYPE
The type returned by the type analyzer when a known type can not be determined |
| Method Summary | |
String |
getBuildableType()
Retrieves the Artifact type representing a buildable
artifact. |
String |
getDeployableArtifactType()
Retrieves the Artifact type representing a deployable
Eclipse artifact. |
String |
getDeployablePluginType()
Deprecated. see getDeployableArtifactType() |
String |
getFolderType()
Retrieves the default Artifact type representing a folder |
String |
getManifestType()
Retrieves the Artifact type representing a RAS manifest. |
String |
getProjectType()
Retrieves the default Artifact type representing a project |
ArtifactResourceTypeEnum |
getResourceType(String theType)
Returns the physical resource type defined for an Artifact
type |
String |
getType(File theFile)
Determines the type of a File object. |
String |
getType(org.eclipse.core.resources.IFile theFileResource)
Determines the type of an IFile resource. |
String |
getType(org.eclipse.core.resources.IFolder theFolderResource)
Determines the type of an IFolder resource. |
String |
getType(org.eclipse.core.resources.IProject theProjectResource)
Determines the type of an IProject resource. |
String |
getType(org.eclipse.core.resources.IResource theResource)
Determines the type of an IResource. |
String |
getType(String theResourceIdentifier)
Determines the type of a resource using a String to
identify it. |
boolean |
isBuildable(String theType)
Determines if a particular type is a buildable artifact |
boolean |
isDeployableArtifact(String theType)
Determines if a particular type is a deployable Eclipse project artifact. |
boolean |
isDeployablePlugin(String theType)
Deprecated. see isDeployableArtifact(String) |
boolean |
isFolder(String theType)
Determines if a particular type is the default folder type defined by RAS. |
boolean |
isManifest(String theType)
Determines if a particular type is the default RAS manifest type defined by RAS. |
boolean |
isProject(String theType)
Determines if a particular type is the default project type defined by RAS. |
| Field Detail |
public static final String UNKNOWN_TYPE
| Method Detail |
public String getType(String theResourceIdentifier)
String to
identify it. The identifier should represent one of the artifact
descriptors being managed by the IArtifactDescriptorManager.
theResourceIdentifier - the String identifying the physical resource
UNKNOWN_TYPEif undefined
IllegalArgumentException - if the theResourceIdentifier is nullIArtifactDescriptorManagerpublic String getType(org.eclipse.core.resources.IResource theResource)
IResource. It's the
responsibility of the ITypeAnalyzer to interrogate the
IResource and return the appropriate type.
theResource - the IResource identifying the physical resource
UNKNOWN_TYPEif undefined
IllegalArgumentException - if the theResource is nullpublic String getType(org.eclipse.core.resources.IFile theFileResource)
IFile resource. It's the
responsibility of the ITypeAnalyzer to interrogate the
IFile resource and return the appropriate type.
theFileResource - the IFile identifying the physical resource
UNKNOWN_TYPEif undefined
IllegalArgumentException - if the theFileResource is nullpublic String getType(File theFile)
File object. It's the
responsibility of the ITypeAnalyzer to interrogate the
File resource and return the appropriate type. The
File object can be a directory.
theFile - the File identifying the physical resource
UNKNOWN_TYPEif undefined
IllegalArgumentException - if the theFile is nullpublic String getType(org.eclipse.core.resources.IFolder theFolderResource)
IFolder resource. It's the
responsibility of the ITypeAnalyzer to interrogate the
IFolder resouce and return the appropriate type.
theFolderResource - the IFolder identifying the physical resouce
IllegalArgumentException - if the theFolderResource is nullpublic String getType(org.eclipse.core.resources.IProject theProjectResource)
IProject resource. It's the
responsibility of the ITypeAnalyzer to interrogate the
IProject resouce and return the appropriate type.
theProjectResource - the IProject identifying the physical resouce
IllegalArgumentException - if the theProjectResource is nullpublic String getFolderType()
Artifact type representing a folder
Artifact as a folderpublic boolean isFolder(String theType)
theType - to determine if it's the default folder type.
true if theType is a type
recognized as the default folder type.
IllegalArgumentException - if the theType is nullpublic String getProjectType()
Artifact type representing a project
Artifact as a projectpublic boolean isProject(String theType)
theType - to determine if it's the default project type.
true if theType is a type
recognized as the default project type.
IllegalArgumentException - if the theType is nullpublic String getDeployableArtifactType()
Artifact type representing a deployable
Eclipse artifact. The artifact in it's deployed state will be one of the
following:
Artifact as
deployable in Eclipse.public boolean isDeployableArtifact(String theType)
theType - to determine if it's a deployable artifact.
true if theType is a type
recognized as a deployable in Eclipse
IllegalArgumentException - if the theType is nullpublic String getDeployablePluginType()
getDeployableArtifactType()
Artifact type representing a deployable
plugin
Artifact as a
deployable pluginpublic boolean isDeployablePlugin(String theType)
isDeployableArtifact(String)
theType - to determine if it's a deployable plugin.
true if theType is a type
recognized as a deployable plugin
IllegalArgumentException - if the theType is nullpublic String getBuildableType()
Artifact type representing a buildable
artifact.
Artifact as a
buildable artifactpublic boolean isBuildable(String theType)
theType - to determine if it's a buildable artifact
true if theType is a type
recognized as a buildable artifact.
IllegalArgumentException - if the theType is nullpublic String getManifestType()
Artifact type representing a RAS manifest.
Artifact as a
RAS Manifestpublic boolean isManifest(String theType)
theType - to determine if it's the default RAS manifest type
true if theType is a type
recognized as a RAS manifest.
IllegalArgumentException - if the theType is nullpublic ArtifactResourceTypeEnum getResourceType(String theType)
Artifact
type
theType - to get the resource type for
null if the
theType is unknown
IllegalArgumentException - if the theType is null
|
IBM Rational Software Modeler Release 6.0 |
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2004. All rights reserved.