|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.5.0) E13403-06 |
|||||||||
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.DeployElement
oracle.jdeveloper.deploy.dt.Profile
oracle.jdeveloper.deploy.jar.ArchiveProfile
public class ArchiveProfile
Data model for the JAR (simple archive) deployment profile.
Field Summary | |
---|---|
static java.lang.String |
ACTION_DEPLOY_TO_JAR_FILE |
static java.lang.String |
ACTION_PREVIEW |
static java.lang.String |
ACTION_SETTINGS_DIALOG |
Fields inherited from class oracle.jdeveloper.deploy.dt.Profile |
---|
_dataContainer, _dependableContainer, PROFILE_CLASS_NAME, PROFILE_DEPENDENCIES, PROFILE_NAME |
Fields inherited from class oracle.javatools.data.HashStructureAdapter |
---|
_hash |
Constructor Summary | |
---|---|
ArchiveProfile() Constructs an ArchiveProfile having default deployment actions and summary steps. |
|
ArchiveProfile(boolean showJarSummary, boolean showDeployJarAction, boolean showCustomSummary) Constructs an ArchiveProfile from the given boolean arguments that facilitate customizing the deployment actions and summary steps. |
|
ArchiveProfile(HashStructure hash) Constructs an ArchiveProfile from the given HashStructure and having default deployment actions and summary steps. |
|
ArchiveProfile(HashStructure hash, boolean showJarSummary, boolean showDeployJarAction, boolean showCustomSummary) Constructs an ArchiveProfile from the given HashStructure and boolean arguments that facilitate customizing the deployment actions and summary steps. |
Method Summary | |
---|---|
void |
addFileGroup(oracle.jdeveloper.deploy.common.FileGroup fileGroup) Adds the specified FileGroup to this archive profile. |
boolean |
canPackage(Element element) This indicates if a profile has the ability to package the element within it's own module. |
oracle.jdeveloper.deploy.common.LibraryFileGroup |
findLibraryFileGroup(java.lang.String internalName) Returns the first LibraryFileGroup with the specified internal name. |
protected java.util.List<oracle.jdeveloper.deploy.common.LibraryFileGroup> |
findLibraryFileGroups() |
oracle.jdeveloper.deploy.common.PackagingFileGroup |
findPackagingFileGroup(java.lang.String internalName) Returns the first PackagingFileGroup with the specified internal name. |
oracle.jdeveloper.deploy.common.ProjectFileGroup |
findProjectFileGroup(java.lang.String internalName) Returns the first ProjectFileGroup with the specified internal name. |
ArchiveOptions |
getArchiveOptions() Returns a structure describing the JAR options that should be applied when building the output JAR. |
javax.swing.tree.DefaultMutableTreeNode |
getCustomSummary() This method is intended to be overridden in subclasses that wish to provide a customized summary in the form of a DefaultMutableTreeNode . |
oracle.jdeveloper.deploy.common.FileGroups |
getFileGroups() Returns the FileGroups that represents the packaging instructions the user has specified in the deployment profile. |
java.net.URL |
getJarURL() Returns the URL that will be added to the class path of a project that depends on this profile. |
oracle.jdeveloper.deploy.common.SelectedProjectFiles |
getSelectedProjectFiles() Deprecated. Use FileGroups instead; this method returns a disconnected SelectedProjectFiles object (i.e. changing the object has no effect on profile behavior). |
protected void |
initArchiveProfile(java.lang.Class<? extends DataContainer> profileContainerClass) |
boolean |
isClasspathJar() Returns true if the deployed output of this profile can be used as a JAR file on a classpath. |
static ArchiveProfile |
newDefaultArchiveProfile() |
static ArchiveProfile |
newDefaultArchiveProfile(java.lang.Class<? extends ArchiveProfile> prototypeClass) Returns an instance of a class that extends ArchiveProfile because it uses the prototype class passed in to do the construction work. |
static ArchiveProfile |
newDefaultArchiveProfile(java.lang.Class<? extends DataContainer> profileContainerClass, java.lang.Class<? extends ArchiveProfile> prototypeClass) |
boolean |
resolvesLibrary(oracle.jdevimpl.deploy.common.DependentLibrary library) This method indicates whether this profile resolves the given library. |
void |
selectLibraryForDeployment(java.lang.Object id) Selects the specified library for deployment by searching for a LibraryFileGroup with the default internal id and adding the specified library to its list. |
void |
setArchiveOptions(ArchiveOptions archiveOptions) |
void |
setFileGroups(oracle.jdeveloper.deploy.common.FileGroups fileGroups) |
void |
setJarURL(java.net.URL jarURL) |
boolean |
showCustomSummary() If this method returns true, the Summary step of the deployment wizard includes a customized summary as provided by the getCustomSummary API. |
boolean |
showDeployJarAction() |
boolean |
showJarSummary() |
Methods inherited from class oracle.jdeveloper.deploy.dt.DeployElement |
---|
attach, detach, getAttributes, getChildren, getData, getIcon, getLongLabel, getToolTipText, isDirty, linkContainingDirtyable, linkEmbeddedDirtyable, linkEmbeddedDirtyable, linkEmbeddedDirtyables, markDirty, mayHaveChildren, notifyObservers, setOwner, toString, unlinkContainingDirtyable, unlinkEmbeddedDirtyable, unlinkEmbeddedDirtyable, unlinkEmbeddedDirtyables |
Methods inherited from class oracle.javatools.data.HashStructureAdapter |
---|
addStructureChangeListener, containsKey, copyToImpl, equalsImpl, findOrCreate, forcedCopyTo, removeStructureChangeListener, useObjectEquals |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface oracle.javatools.util.Copyable |
---|
copyTo |
Methods inherited from interface oracle.jdeveloper.deploy.common.Interdependency |
---|
addDependency, getDependencies, removeDependency |
Field Detail |
---|
public static final java.lang.String ACTION_DEPLOY_TO_JAR_FILE
public static final java.lang.String ACTION_PREVIEW
public static final java.lang.String ACTION_SETTINGS_DIALOG
Constructor Detail |
---|
public ArchiveProfile()
public ArchiveProfile(HashStructure hash)
HashStructure
and having default deployment actions and summary steps. That is, when the profile is opened at deployment time, the wizard will show at least the following:
public ArchiveProfile(HashStructure hash, boolean showJarSummary, boolean showDeployJarAction, boolean showCustomSummary)
HashStructure
and boolean arguments that facilitate customizing the deployment actions and summary steps. That is, when the profile is opened at deployment time, the wizard will show:
getCustomSummary
method. If showJarSummary is also true, then the customized summary is appended to the end of the Archive Summary, otherwise, only the customized summary is included in the deployment wizard.hash
- a HashStructure
containing the profile information.showJarSummary
- whether or not the Archive Summary should be included in the deployment wizard.showDeployJarAction
- whether or not the Deploy to JAR file action should be included in the deployment wizard.showCustomSummary
- whether or not a customized summary should be included in the deployment wizard.public ArchiveProfile(boolean showJarSummary, boolean showDeployJarAction, boolean showCustomSummary)
getCustomSummary
method. If showJarSummary is also true, then the customized summary is appended to the end of the Archive Summary, otherwise, only the customized summary is included in the deployment wizard.showJarSummary
- whether or not the Archive Summary should be included in the deployment wizard.showDeployJarAction
- whether or not the Deploy to JAR file action should be included in the deployment wizard.showCustomSummary
- whether or not a customized summary should be included in the deployment wizard.Method Detail |
---|
public static ArchiveProfile newDefaultArchiveProfile()
public static ArchiveProfile newDefaultArchiveProfile(java.lang.Class<? extends ArchiveProfile> prototypeClass)
prototypeClass
- The class to get the instance of, which can null to get an instance of ArchiveProfile itself.public static ArchiveProfile newDefaultArchiveProfile(java.lang.Class<? extends DataContainer> profileContainerClass, java.lang.Class<? extends ArchiveProfile> prototypeClass)
protected void initArchiveProfile(java.lang.Class<? extends DataContainer> profileContainerClass)
public boolean showJarSummary()
public boolean showCustomSummary()
getCustomSummary
API. If the profile was also constructed to show the JAR summary, then the custom summary is appended to the end of the JAR summary. Otherwise, only the custom summary appears in the wizard.public boolean showDeployJarAction()
public javax.swing.tree.DefaultMutableTreeNode getCustomSummary()
DefaultMutableTreeNode
.public java.net.URL getJarURL()
JarPackaging
URL
that will be added to the class path of a project that depends on this profile.getJarURL
in interface JarPackaging
public void setJarURL(java.net.URL jarURL)
public ArchiveOptions getArchiveOptions()
JarPackaging
getArchiveOptions
in interface JarPackaging
public void setArchiveOptions(ArchiveOptions archiveOptions)
public oracle.jdeveloper.deploy.common.FileGroups getFileGroups()
JarPackaging
getFileGroups
in interface JarPackaging
public void setFileGroups(oracle.jdeveloper.deploy.common.FileGroups fileGroups)
public boolean isClasspathJar()
public void addFileGroup(oracle.jdeveloper.deploy.common.FileGroup fileGroup)
public oracle.jdeveloper.deploy.common.PackagingFileGroup findPackagingFileGroup(java.lang.String internalName)
public oracle.jdeveloper.deploy.common.ProjectFileGroup findProjectFileGroup(java.lang.String internalName)
public oracle.jdeveloper.deploy.common.LibraryFileGroup findLibraryFileGroup(java.lang.String internalName)
public void selectLibraryForDeployment(java.lang.Object id)
protected java.util.List<oracle.jdeveloper.deploy.common.LibraryFileGroup> findLibraryFileGroups()
public boolean resolvesLibrary(oracle.jdevimpl.deploy.common.DependentLibrary library)
resolvesLibrary
in class Profile
library
- The library to be evaluated.public boolean canPackage(Element element)
public final oracle.jdeveloper.deploy.common.SelectedProjectFiles getSelectedProjectFiles() throws TransientMarker
TransientMarker
|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.5.0) E13403-06 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |