|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IRuntimeType
Represents a (server) runtime type from which runtime instances can be created.
The server core framework supports
an open-ended set of runtime types, which are contributed via
the runtimeTypes
extension point in the server core
plug-in. Runtime type objects carry no state (all information is
read-only and is supplied by the server runtime type declaration).
The global list of known runtime types is available via
ServerCore.getRuntimeTypes()
.
This interface is not intended to be implemented by clients.
[issue: What value do runtimes add? It's main role is for setting up the Java build classpath for projects holding modules that must be Java compiled. If the notion of module is to transcend the vagaries of particular types of server, and, indeed, be published to multiple servers simultaneously, then matters of build classpath had better not be tied to the particular servers involved.]
Two runtime types are identical if and only if they have the same id.
Method Summary | |
---|---|
boolean |
canCreate()
Returns whether this runtime type can be instantiated. |
IRuntimeWorkingCopy |
createRuntime(java.lang.String id,
IProgressMonitor monitor)
Creates a working copy instance of this runtime type. |
java.lang.String |
getDescription()
Returns the displayable description for this runtime type. |
java.lang.String |
getId()
Returns the id of this runtime type. |
IModuleType[] |
getModuleTypes()
Returns an array of module types that this runtime type can support. |
java.lang.String |
getName()
Returns the displayable name for this runtime type. |
java.lang.String |
getVendor()
Returns the displayable vendor name for this runtime type. |
java.lang.String |
getVersion()
Returns the displayable version name for this runtime type. |
Method Detail |
---|
java.lang.String getId()
java.lang.String getName()
Note that this name is appropriate for the current locale.
java.lang.String getDescription()
Note that this description is appropriate for the current locale.
java.lang.String getVendor()
Note that this description is appropriate for the current locale.
java.lang.String getVersion()
Note that this description is appropriate for the current locale.
IModuleType[] getModuleTypes()
A new array is returned on each call, so clients may store or modify the result.
IModuleType
boolean canCreate()
[issue: It's unclear what this method is for. The implementation checks whether the "class" and "workingCopyClass" attributes (both optional) were specified. What would be the point of a runtime type that didn't have both of these attributes and could not be "created"?]
true
if this type of runtime can be
instantiated, and false
if it cannotcreateRuntime(String, IProgressMonitor)
IRuntimeWorkingCopy createRuntime(java.lang.String id, IProgressMonitor monitor) throws CoreException
IRuntimeWorkingCopy.save(boolean, IProgressMonitor)
to bring the runtime instance into existence.
Default values are set by calling the instance's delegate. Clients should assume that the location and other properties are not set and must be explicitly set by the client.
id
- the id to assign to the runtime instance; the default name is
used if id is null
or an empty stringmonitor
- a progress monitor, or null
if progress
reporting and cancellation are not desired
CoreException
- if an exception occurs while creating this runtime
or setting it's default values
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |