|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.7.2) E13403-10 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.ide.controller.Command
oracle.jdeveloper.deploy.cmd.DeployCommand
public abstract class DeployCommand
Nested Class Summary | |
---|---|
static interface |
DeployCommand.Callback An object that can inspect the DeployShell at various stages. |
static class |
DeployCommand.CommandInstantiationException |
static class |
DeployCommand.Status |
Field Summary |
---|
Fields inherited from class oracle.ide.controller.Command |
---|
CANCEL, context, EXECUTING, MULTI_NODE, NO_CHANGE, NO_UNDO, NORMAL, OK, type |
Constructor Summary | |
---|---|
DeployCommand(HashStructure hash) |
|
DeployCommand(int cmdId, int type, int sequenceId) |
Method Summary | |
---|---|
static DeployCommand |
create(HashStructure hash) |
protected void |
deploy(DeployShell shell) |
int |
doit() Executes the actions associated with a specific command. |
protected void |
exception(java.lang.Exception e, DeployShell shell) Called when an exception is thrown from deployment. |
protected void |
finished(DeployShell shell) Called after deployment has finished running. |
Attributes |
getAttributes() This method returns an Attributes object that encodes the attributes of the Element . |
java.util.Iterator<Element> |
getChildren() This method is part of the Element interface to provide a convenient way of getting an Iterator over any contained child Element s without having to test the object's type with the instanceof operator or having to downcast to a more specific type. |
protected DeployShellFactory |
getDeployShellFactory() |
javax.swing.Icon |
getIcon() Returns an Icon that can be shown in association with this Displayable . |
java.lang.String |
getLongLabel() Returns a long label that can be displayed to the user. |
oracle.jdeveloper.deploy.meta.Platform |
getPlatform() |
int |
getSequenceId() |
abstract java.lang.String |
getShortLabel() Returns a short label that can be displayed to the user. |
DeployCommandState |
getState() |
protected abstract java.lang.Class<? extends DeployCommandState> |
getStateClass() |
DeployCommand.Status |
getStatus() |
java.lang.String |
getToolTipText() Returns the tool tip text to show when the mouse pointer pauses over a UI component that represents this Displayable . |
protected abstract boolean |
isReady() |
boolean |
mayHaveChildren() This method is part of the Element interface to provide a convenient way of determining whether an object may have children without having to test the object's type with the instanceof operator or having to downcast to a more specific type. |
protected DeployCommandState |
newState() |
protected DeployCommandState |
newState(HashStructure hash) |
protected void |
prepare(DeployShell shell) Prepares for deployment. |
void |
setCallback(DeployCommand.Callback callback) |
void |
setPlatform(oracle.jdeveloper.deploy.meta.Platform platform) |
void |
setState(DeployCommandState state) |
protected void |
setStatus(DeployCommand.Status status) |
protected DeployCommandState |
state() |
protected void |
updateStatus() |
Methods inherited from class oracle.ide.controller.Command |
---|
getAffectedNodes, getContext, getData, getId, getName, getType, isGlobal, setContext, setData, undo |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface oracle.ide.model.Element |
---|
getData |
Methods inherited from interface oracle.ide.model.Displayable |
---|
toString |
Constructor Detail |
---|
public DeployCommand(int cmdId, int type, int sequenceId)
public DeployCommand(HashStructure hash)
Method Detail |
---|
public boolean mayHaveChildren()
Element
Element
interface to provide a convenient way of determining whether an object may have children without having to test the object's type with the instanceof
operator or having to downcast to a more specific type.
An implementation of Element
that represents a leaf in a tree structure should return false
from this method. An implementation of Element
that could represent a non-leaf in a tree structure should return true
from this method, even if it does not currently contain any children.
mayHaveChildren
in interface Element
true
if this Element
may contain child Element
s.public java.util.Iterator<Element> getChildren()
Element
Element
interface to provide a convenient way of getting an Iterator
over any contained child Element
s without having to test the object's type with the instanceof
operator or having to downcast to a more specific type.
An implementation of Element
that represents a leaf in a tree structure should return null
from this method. An implementation of Element
that could represent a non-leaf in a tree structure should return either an Iterator
over the child Element
s or null
if there are no children.
getChildren
in interface Element
Iterator
over any child Element
s contained by this Element
. If there are no children, null
is returned.public Attributes getAttributes()
Element
Attributes
object that encodes the attributes of the Element
. Changing the attribute settings on the return object changes the element attributes. Subclasses should use their super class attributes object to define their own attributes. This allows subclasses to inherit their super class attributes. If a subclass does not wish to inherit attributes, they should first call getAttributes().clear()
and define new attributes.getAttributes
in interface Element
public javax.swing.Icon getIcon()
Displayable
Icon
that can be shown in association with this Displayable
. Typically the icon will be used in a tree control or list control. Therefore the icon must fit naturally within the space normally given to items within those controls. Such icons are usually 16x16 in size or, if there is a one-pixel transparent padding around the edge, 18x18 in size. It is strongly recommended that icons returned by this method be either 16x16 or 18x18 in size. If null
is returned, the control may show a default icon, or it may show no icon, whichever is appropriate.getIcon
in interface Displayable
Icon
to be displayed for the Displayable
.public java.lang.String getToolTipText()
Displayable
Displayable
. In many cases it may be appropriate for this method to return the same value as Displayable.getLongLabel()
.getToolTipText
in interface Displayable
Displayable
.public java.lang.String getLongLabel()
Displayable
String
is considered translatable and should therefore be placed in an appropriate resource file. The long label differs from the short label essentially on length. Usually the long label will only be shown on-demand and in places where horizontal space is more available. Examples are the status bar and tooltips.getLongLabel
in interface Displayable
Displayable
that can be shown to the user.public void setPlatform(oracle.jdeveloper.deploy.meta.Platform platform)
public oracle.jdeveloper.deploy.meta.Platform getPlatform()
public int getSequenceId()
public void setCallback(DeployCommand.Callback callback)
public DeployCommand.Status getStatus()
protected void updateStatus()
protected DeployCommandState newState()
protected DeployCommandState newState(HashStructure hash)
protected abstract java.lang.Class<? extends DeployCommandState> getStateClass()
protected void setStatus(DeployCommand.Status status)
protected abstract boolean isReady()
public int doit() throws java.lang.Exception
Command
doit
in class Command
java.lang.Exception
protected void prepare(DeployShell shell)
DeployShell
.
Use a wrapper to configure the shell.
shell
-JavaDeployment
protected void deploy(DeployShell shell) throws java.lang.Exception
java.lang.Exception
protected void exception(java.lang.Exception e, DeployShell shell)
e
-shell
-protected void finished(DeployShell shell)
shell
-protected DeployShellFactory getDeployShellFactory()
protected DeployCommandState state()
public abstract java.lang.String getShortLabel()
Displayable
String
is considered translatable and should therefore be placed in an appropriate resource file. When possible, the returned label should be reasonably short enough to show in the navigator or explorer windows but long enough to clearly identify and distinguish the Displayable
.getShortLabel
in interface Displayable
Displayable
that can be shown to the user.public DeployCommandState getState()
public void setState(DeployCommandState state)
public static DeployCommand create(HashStructure hash)
|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.7.2) E13403-10 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |