|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.eclipse.wst.server.core.model.RuntimeDelegate
A runtime delegate provides the implementation for various
generic and server-type-specific operations for a specific type of runtime.
A runtime delegate is specified by the
class
attribute of a runtimeTypes
extension.
When the runtime instance needs to be given a delegate, the delegate class
specified for the runtime type is instantiated with a 0-argument constructor
and primed with delegate.initialize(runtime)
,
which it is expected to hang on to. Later, when
delegate.dispose()
is called as the runtime instance is
being discarded, the delegate is expected to let go of the runtime instance.
RuntimeDelegate supports an open-ended set of attribute-value pairs. All state stored in this manner will be saved when the runtime working copy is saved, and persisted across workbench sessions. Runtime delegates may keep state in instance fields, but that state is transient and will not be persisted across workbench sessions. To save state across workbench sessions, it must be persisted using the attributes.
This abstract class is intended to be extended only by clients
to extend the runtimeTypes
extension point.
IRuntime
,
IRuntimeWorkingCopy
Constructor Summary | |
---|---|
RuntimeDelegate()
Delegates must have a public 0-arg constructor. |
Method Summary | |
---|---|
void |
dispose()
Disposes of this runtime delegate. |
boolean |
getAttribute(java.lang.String id,
boolean defaultValue)
Returns the value of the specified boolean-valued attribute. |
int |
getAttribute(java.lang.String id,
int defaultValue)
Returns the value of the specified int-valued attribute. |
java.util.List |
getAttribute(java.lang.String id,
java.util.List defaultValue)
Returns the value of the specified List-valued attribute. |
java.util.Map |
getAttribute(java.lang.String id,
java.util.Map defaultValue)
Returns the value of the specified Map-valued attribute. |
java.lang.String |
getAttribute(java.lang.String id,
java.lang.String defaultValue)
Returns the value of the specified String-valued attribute. |
IRuntime |
getRuntime()
Returns the runtime that this runtime delegate corresponds to. |
IRuntimeWorkingCopy |
getRuntimeWorkingCopy()
Returns the runtime working copy that this runtime delegate corresponds to. |
void |
initialize()
Initializes this runtime delegate. |
void |
initialize(org.eclipse.wst.server.core.internal.Runtime newRuntime)
Initializes this runtime delegate with its life-long runtime instance. |
void |
setAttribute(java.lang.String id,
boolean value)
Sets the value of the specified boolean-valued attribute of this element. |
void |
setAttribute(java.lang.String id,
int value)
Sets the value of the specified integer-valued attribute of this element. |
void |
setAttribute(java.lang.String id,
java.util.List value)
Sets the value of the specified list-valued attribute of this element. |
void |
setAttribute(java.lang.String id,
java.util.Map value)
Sets the value of the specified map-valued attribute of this element. |
void |
setAttribute(java.lang.String id,
java.lang.String value)
Sets the value of the specified string-valued attribute of this element. |
void |
setDefaults()
Initializes this runtime with default values. |
IStatus |
validate()
Validates this runtime instance. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public RuntimeDelegate()
Method Detail |
public final void initialize(org.eclipse.wst.server.core.internal.Runtime newRuntime)
This method is called by the server core framework. Clients should never call this method.
newRuntime
- the runtime instancepublic void initialize()
This method is called by the server core framework. Clients should never call this method.
public IRuntime getRuntime()
public IRuntimeWorkingCopy getRuntimeWorkingCopy()
public IStatus validate()
This method is called by the web server core framework,
in response to a call to IRuntime.validate(IProgressMonitor)
.
Clients should never call this method.
IStatus.OK
if this
runtime is valid, otherwise a status object indicating what is
wrong with itpublic int getAttribute(java.lang.String id, int defaultValue)
id
- the attribute iddefaultValue
- the default value of the specified attribute
setAttribute(String, int)
public boolean getAttribute(java.lang.String id, boolean defaultValue)
id
- the attribute iddefaultValue
- the default value of the specified attribute
setAttribute(String, boolean)
public java.lang.String getAttribute(java.lang.String id, java.lang.String defaultValue)
id
- the attribute iddefaultValue
- the default value of the specified attribute
setAttribute(String, String)
public java.util.List getAttribute(java.lang.String id, java.util.List defaultValue)
id
- the attribute iddefaultValue
- the default value of the specified attribute
setAttribute(String, List)
public java.util.Map getAttribute(java.lang.String id, java.util.Map defaultValue)
id
- the attribute iddefaultValue
- the default value of the specified attribute
setAttribute(String, Map)
public void dispose()
This method is called by the web server core framework. Clients should never call this method.
Implementations are expected to let go of the delegate's reference to the runtime, deregister listeners, etc.
public void setDefaults()
public void setAttribute(java.lang.String id, int value)
id
- the attribute idvalue
- the value of the specified attributegetAttribute(String, int)
public void setAttribute(java.lang.String id, boolean value)
id
- the attribute idvalue
- the value of the specified attributegetAttribute(String, boolean)
public void setAttribute(java.lang.String id, java.lang.String value)
id
- the attribute idvalue
- the value of the specified attributegetAttribute(String, String)
public void setAttribute(java.lang.String id, java.util.List value)
id
- the attribute idvalue
- the value of the specified attributegetAttribute(String, List)
public void setAttribute(java.lang.String id, java.util.Map value)
id
- the attribute idvalue
- the value of the specified attributegetAttribute(String, Map)
|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |