|
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.javatools.data.HashStructureAdapter
oracle.jdeveloper.deploy.dt.DeploymentProfiles
public class DeploymentProfiles
Nested Class Summary | |
---|---|
class |
DeploymentProfiles.ProfileIterator |
Field Summary | |
---|---|
static java.lang.String |
DATA_KEY Use DATA_KEY to get the DeploymentProfiles from a containing HashStructure. |
static java.lang.String |
DEFAULT_PROFILE_KEY |
static java.lang.String |
DEFAULT_PROFILE_NAME |
static java.lang.String |
PROFILE_DEFINITIONS |
static java.lang.String |
PROFILE_LIST |
Fields inherited from class oracle.javatools.data.HashStructureAdapter |
---|
_hash |
Method Summary | |
---|---|
void |
addProfile(Profile profile) Adds a new Profile to DeploymentProfiles. |
Attributes |
getAttributes() This method returns an Attributes object that encodes the attributes of the Element . |
java.util.Iterator |
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. |
java.lang.Object |
getData() Returns the data object associated with this Element . |
Profile |
getDefaultDeploymentProfile() Gets the default profile from the container. |
java.util.Map |
getDefinedProfiles(boolean longProfileName) Deprecated. |
javax.swing.Icon |
getIcon() Returns an Icon that can be shown in association with this Displayable . |
static DeploymentProfiles |
getInstance(DataContainer container) |
static DeploymentProfiles |
getInstance(DataContainer container, boolean userPropertiesMode) |
java.lang.String |
getLongLabel() Returns a long label that can be displayed to the user. |
Profile |
getProfileByName(java.lang.String name) Retrieve a Profile by its unique name. |
static Profile |
getProfileByShortLabel(DataContainer container, java.lang.String name) Deprecated. |
java.util.Set |
getProfileNames() |
Profile[] |
getProfiles() Returns all Profiles associated with the container. |
java.lang.String |
getShortLabel() Returns a short label that can be displayed to the user. |
java.lang.String |
getToolTipText() Returns the tool tip text to show when the mouse pointer pauses over a UI component that represents this Displayable . |
static boolean |
isCustomSettingsActive(DataContainer container) |
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. |
static boolean |
profileExists(DataContainer container, Profile profile) Deprecated. The isExist() question should be answered by the Dependable pointing to that Profile. See ProfileDependable.doesExist(). |
static void |
projectMigrating(Project project, TraversableContext tc) |
void |
removeProfile(java.lang.String profileName) Removes the given Profile from DeploymentProfiles. |
void |
setDefaultDeploymentProfile(Profile profile) Sets the default profile for this container. |
void |
setDeploymentProfiles(Profile[] profiles) |
Profile[] |
toSortedArray() Returns all Profiles associated with the container, sorted by name. |
java.lang.String |
toString() Returns the Short Label displayed to a user. |
static void |
validateProfileName(java.util.Set usedNames, java.lang.String profileName, java.lang.String titlePrefix) Validates a deployment profile name throwing a TraversalException when the given profile name is invalid. |
Methods inherited from class oracle.javatools.data.HashStructureAdapter |
---|
addStructureChangeListener, containsKey, copyTo, copyToImpl, equals, equalsImpl, findOrCreate, forcedCopyTo, getHashStructure, removeStructureChangeListener, useObjectEquals |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String DATA_KEY
DATA_KEY
to get the DeploymentProfiles from a containing HashStructure.public static final java.lang.String PROFILE_DEFINITIONS
public static final java.lang.String PROFILE_LIST
public static final java.lang.String DEFAULT_PROFILE_KEY
public static final java.lang.String DEFAULT_PROFILE_NAME
Method Detail |
---|
public static DeploymentProfiles getInstance(DataContainer container)
public static DeploymentProfiles getInstance(DataContainer container, boolean userPropertiesMode)
public void addProfile(Profile profile) throws InvalidProfileException, ProfileOperationException
profile
-InvalidProfileException
ProfileOperationException
public void removeProfile(java.lang.String profileName) throws InvalidProfileException, ProfileOperationException
profile
-InvalidProfileException
ProfileOperationException
public static void projectMigrating(Project project, TraversableContext tc)
public void setDefaultDeploymentProfile(Profile profile)
profile
-public Profile getDefaultDeploymentProfile()
@Deprecated
public java.util.Map getDefinedProfiles(boolean longProfileName)
public java.util.Set getProfileNames()
public static void validateProfileName(java.util.Set usedNames, java.lang.String profileName, java.lang.String titlePrefix) throws TraversalException
usedNames
- a Set of deployment profile names already present in the DataContainer(project/workspace)profileName
- a new profile name proposed to be added.titlePrefix
- in case of an exception, this title Prefix will be used to format the complete title found in the TraversalException.getTitle().TraversalException
public Profile[] toSortedArray()
public Profile[] getProfiles()
public static boolean isCustomSettingsActive(DataContainer container)
public void setDeploymentProfiles(Profile[] profiles)
@Deprecated
public static Profile getProfileByShortLabel(DataContainer container,
java.lang.String name)
public Profile getProfileByName(java.lang.String name)
name
-
@Deprecated
public static boolean profileExists(DataContainer container,
Profile profile)
container
-profile
-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 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 java.lang.Object getData()
Element
Element
. Implementations will often simply return this
, since the Element is often its own data object. If the implementation returns an object other than this
, be sure to set ElementAttributes.DECORATES_DATA_ELEMENT
.getData
in interface Element
Element
instance.public 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 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 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 toString()
Displayable
toString
method in java.lang.Object
.
Implementors of the Displayable
interface should override this as appropriate. The default implementation is the same as getShortLabel
toString
in interface Displayable
toString
in class java.lang.Object
Object.toString()
, Displayable.getShortLabel()
|
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 |