oracle.jdeveloper.library

Class ManifestLibrary

java.lang.Object

oracle.jdeveloper.library.ManifestLibrary

All Implemented Interfaces:

Displayable, oracle.javatools.exports.library.ExportLibrary, JLibrary, JLibraryDefinition, JPaths, Library

public final class ManifestLibrary
extends java.lang.Object
implements JLibrary, oracle.javatools.exports.library.ExportLibrary

A manifest library loaded from a .library file.

Field Summary

Fields inherited from interface oracle.jdeveloper.library.JLibrary

DEPLOYED_BY_DEFAULT_PROPERTY

Fields inherited from interface oracle.jdeveloper.library.Library

LIBRARY_ID_PROPERTY, LIBRARY_NAME_PROPERTY

Fields inherited from interface oracle.jdeveloper.library.JPaths

CLASSPATH_PROPERTY, DOCPATH_PROPERTY, ISLOCKED_PROPERTY, SOURCEPATH_PROPERTY

Constructor Summary

Constructors

Constructor and Description
ManifestLibrary(oracle.javatools.exports.library.FileExportLibrary library)

Method Summary

Modifier and Type	Method and Description
boolean	equivalent(Library library) Determine whether the given Library is equivalent to this one with respect to the values of its public properties other than name.
URLPath	getClassPath()
URLPath	getDefaultClassPath() Deprecated. use getClassPath()
URLPath	getDefaultDocPath() Deprecated. use getDocPath()
JLibraryDefinition	getDefaultLibraryDefinition() Deprecated. JDK based versions desupported. Use JLibrary directly.
URLPath	getDefaultSourcePath() Deprecated. use getSourcePath()
java.util.Collection<oracle.javatools.exports.library.LibraryDependency>	getDependencies()
java.lang.Boolean	getDeployedByDefault()
java.lang.String	getDescription()
URLPath	getDocPath()
java.util.Map<java.lang.String,java.util.List<java.net.URL>>	getExportSpecificationPaths()
javax.swing.Icon	getIcon() Returns an Icon that can be shown in association with this Displayable.
java.lang.String	getId()
java.lang.Object	getID()
JLibraryDefinition	getLibraryDefinition(VersionNumber jdkVer) Deprecated. JDK based versions desupported. Use JLibrary directly.
java.lang.String	getLongLabel() Returns a long label that can be displayed to the user.
java.lang.String	getName()
java.net.URL	getOrigin()
java.util.List<java.net.URL>	getRemediationCommentsPaths()
java.util.Collection<oracle.javatools.exports.library.ClassPathEntry>	getResolvedClassPath()
java.util.Map<java.lang.String,java.lang.String>	getResolvedRemediationComments()
java.lang.String	getShortLabel() Returns a short label that can be displayed to the user.
URLPath	getSourcePath()
java.util.Collection<oracle.javatools.exports.library.ClassPathEntry>	getSuppliedClassPath()
java.lang.String	getToolTipText() Returns the tool tip text to show when the mouse pointer pauses over a UI component that represents this Displayable.
void	initFromLibrary(Library library) Initialize all public properties, other than name, from the Library provided.
boolean	isLocked()
void	setClassPath(URLPath clsPath)
void	setDefaultClassPath(URLPath clsPath) Deprecated.
void	setDefaultDocPath(URLPath docPath) Deprecated.
void	setDefaultSourcePath(URLPath srcPath) Deprecated.
void	setDeployedByDefault(java.lang.Boolean deployed)
void	setDocPath(URLPath docPath)
void	setLocked(boolean isLocked)
void	setName(java.lang.String name)
void	setSourcePath(URLPath srcPath)

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.Displayable

getAttributedLabel, toString

Methods inherited from interface oracle.javatools.exports.library.ExportLibrary

syntheticId, syntheticId

Constructor Detail

ManifestLibrary

public ManifestLibrary(oracle.javatools.exports.library.FileExportLibrary library)

Method Detail

getOrigin

public java.net.URL getOrigin()

Specified by:

getOrigin in interface oracle.javatools.exports.library.ExportLibrary

getId

public java.lang.String getId()

Specified by:

getId in interface oracle.javatools.exports.library.ExportLibrary

getName

public java.lang.String getName()

Specified by:

getName in interface oracle.javatools.exports.library.ExportLibrary

Specified by:

getName in interface Library

Returns:

the Library name, or null

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface oracle.javatools.exports.library.ExportLibrary

getDeployedByDefault

public java.lang.Boolean getDeployedByDefault()
                                       throws AttributeMarker

Specified by:

getDeployedByDefault in interface JLibrary

Throws:

AttributeMarker

isLocked

public boolean isLocked()

Specified by:

isLocked in interface JPaths

getClassPath

public URLPath getClassPath()

Specified by:

getClassPath in interface JPaths

Returns:

May be null.

getSuppliedClassPath

public java.util.Collection<oracle.javatools.exports.library.ClassPathEntry> getSuppliedClassPath()

Specified by:

getSuppliedClassPath in interface oracle.javatools.exports.library.ExportLibrary

getResolvedClassPath

public java.util.Collection<oracle.javatools.exports.library.ClassPathEntry> getResolvedClassPath()

Specified by:

getResolvedClassPath in interface oracle.javatools.exports.library.ExportLibrary

getExportSpecificationPaths

public java.util.Map<java.lang.String,java.util.List<java.net.URL>> getExportSpecificationPaths()

Specified by:

getExportSpecificationPaths in interface oracle.javatools.exports.library.ExportLibrary

getRemediationCommentsPaths

public java.util.List<java.net.URL> getRemediationCommentsPaths()

Specified by:

getRemediationCommentsPaths in interface oracle.javatools.exports.library.ExportLibrary

getResolvedRemediationComments

public java.util.Map<java.lang.String,java.lang.String> getResolvedRemediationComments()

Specified by:

getResolvedRemediationComments in interface oracle.javatools.exports.library.ExportLibrary

getDependencies

public java.util.Collection<oracle.javatools.exports.library.LibraryDependency> getDependencies()

Specified by:

getDependencies in interface oracle.javatools.exports.library.ExportLibrary

getSourcePath

public URLPath getSourcePath()

Specified by:

getSourcePath in interface JPaths

Returns:

May be null.

getDocPath

public URLPath getDocPath()

Specified by:

getDocPath in interface JPaths

Returns:

May be null.

getShortLabel

public java.lang.String getShortLabel()

Description copied from interface: Displayable

Returns a short label that can be displayed to the user. Generally, the value of the returned 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.

Specified by:

getShortLabel in interface Displayable

Returns:

a short descriptive label of the Displayable that can be shown to the user.

getLongLabel

public java.lang.String getLongLabel()

Description copied from interface: Displayable

Returns a long label that can be displayed to the user. Generally, the value of the returned 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.

Specified by:

getLongLabel in interface Displayable

Returns:

a long descriptive label of the Displayable that can be shown to the user.

getToolTipText

public java.lang.String getToolTipText()

Description copied from interface: Displayable

Returns the tool tip text to show when the mouse pointer pauses over a UI component that represents this Displayable. In many cases it may be appropriate for this method to return the same value as Displayable.getLongLabel().

Specified by:

getToolTipText in interface Displayable

Returns:

the tooltip to show when the mouse pointer pauses over a UI component that represents this Displayable.

getIcon

public javax.swing.Icon getIcon()

Description copied from interface: Displayable

Returns an 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.

Specified by:

getIcon in interface Displayable

Returns:

the Icon to be displayed for the Displayable.

getID

public java.lang.Object getID()

Specified by:

getID in interface Library

Returns:

the Library id as a String or null

getDefaultClassPath

@Deprecated
public URLPath getDefaultClassPath()

Deprecated. use getClassPath()

Specified by:

getDefaultClassPath in interface Library

getDefaultSourcePath

@Deprecated
public URLPath getDefaultSourcePath()

Deprecated. use getSourcePath()

Specified by:

getDefaultSourcePath in interface Library

getDefaultDocPath

@Deprecated
public URLPath getDefaultDocPath()

Deprecated. use getDocPath()

Specified by:

getDefaultDocPath in interface Library

getDefaultLibraryDefinition

@Deprecated
public JLibraryDefinition getDefaultLibraryDefinition()

Deprecated. JDK based versions desupported. Use JLibrary directly.

Specified by:

getDefaultLibraryDefinition in interface JLibrary

getLibraryDefinition

@Deprecated
public JLibraryDefinition getLibraryDefinition(VersionNumber jdkVer)

Deprecated. JDK based versions desupported. Use JLibrary directly.

Specified by:

getLibraryDefinition in interface JLibrary

setDeployedByDefault

public void setDeployedByDefault(java.lang.Boolean deployed)

Specified by:

setDeployedByDefault in interface JLibrary

Throws:

java.lang.UnsupportedOperationException - instances of this class are immutable.

setClassPath

public void setClassPath(URLPath clsPath)

Specified by:

setClassPath in interface JPaths

Throws:

java.lang.UnsupportedOperationException - instances of this class are immutable.

setDefaultClassPath

@Deprecated
public void setDefaultClassPath(URLPath clsPath)

Deprecated.

Specified by:

setDefaultClassPath in interface Library

Throws:

java.lang.UnsupportedOperationException - instances of this class are immutable.

setDefaultDocPath

@Deprecated
public void setDefaultDocPath(URLPath docPath)

Deprecated.

Specified by:

setDefaultDocPath in interface Library

Throws:

java.lang.UnsupportedOperationException - instances of this class are immutable.

setDefaultSourcePath

@Deprecated
public void setDefaultSourcePath(URLPath srcPath)

Deprecated.

Specified by:

setDefaultSourcePath in interface Library

Throws:

java.lang.UnsupportedOperationException - instances of this class are immutable.

setDocPath

public void setDocPath(URLPath docPath)

Specified by:

setDocPath in interface JPaths

Throws:

java.lang.UnsupportedOperationException - instances of this class are immutable.

setLocked

public void setLocked(boolean isLocked)

Specified by:

setLocked in interface JPaths

Throws:

java.lang.UnsupportedOperationException - instances of this class are immutable.

setName

public void setName(java.lang.String name)

Specified by:

setName in interface Library

Throws:

java.lang.UnsupportedOperationException - instances of this class are immutable.

setSourcePath

public void setSourcePath(URLPath srcPath)

Specified by:

setSourcePath in interface JPaths

Throws:

java.lang.UnsupportedOperationException - instances of this class are immutable.

equivalent

public boolean equivalent(Library library)

Description copied from interface: Library

Determine whether the given Library is equivalent to this one with respect to the values of its public properties other than name.

Specified by:

equivalent in interface Library

Parameters:

library - the Library against which to test for equivalence.

Returns:

true if all public properties are equal.

initFromLibrary

public void initFromLibrary(Library library)

Description copied from interface: Library

Initialize all public properties, other than name, from the Library provided.

Specified by:

initFromLibrary in interface Library

Parameters:

library - the Library from which to fetch property values.