oracle.jdeveloper.library

Class AddinLibrary

java.lang.Object

oracle.ide.model.DefaultDisplayable

oracle.ide.model.DefaultElement

oracle.jdeveloper.library.LibraryElement

oracle.jdeveloper.library.AbstractLibrary

oracle.jdeveloper.library.AddinLibrary

All Implemented Interfaces:

Displayable, Element, Dirtyable, EndorsedStandardsOverride, ExportAwareLibrary, ExtensionLibrary, JLibrary, JLibraryDefinition, JPaths, Library

public final class AddinLibrary
extends AbstractLibrary
implements ExtensionLibrary, EndorsedStandardsOverride, ExportAwareLibrary

Represents a library that was installed in an extension manifest's <libraries> hook.

This class is misnamed for historical reasons. It is not related to Addins.

Thread Safety: instances of this class are immutable, and can be used safely from multiple threads. A copy is taken of the (mutable) URLPath objects passed into the constructor, and these effectively immutable copies are always returned by getClassPath(), getSourcePath(), and getDocPath().

Since:

9.0.2

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
AddinLibrary(java.lang.String id, java.lang.String description, java.util.List<oracle.javatools.exports.ExportLibrary.Dependency> dependencies, java.util.Map<URLKey,oracle.javatools.exports.ExportModel<?>> exports, java.lang.String name, URLPath classPath, URLPath srcPath, URLPath docPath, java.lang.Boolean deployed, java.lang.Boolean forceExtInit, java.lang.String providerExtension, java.lang.Boolean hidden, URLPath endorsedDirs, URLPath endorsedSrcPath, URLPath endorsedDocPath)
AddinLibrary(java.lang.String name, URLPath clsPath, URLPath srcPath, URLPath docPath, java.lang.Boolean deployed)
AddinLibrary(java.lang.String name, URLPath clsPath, URLPath srcPath, URLPath docPath, java.lang.Boolean deployed, java.lang.Boolean forceExtInit, java.lang.String providerExtension)
AddinLibrary(java.lang.String name, URLPath clsPath, URLPath srcPath, URLPath docPath, java.lang.Boolean deployed, java.lang.Boolean forceExtInit, java.lang.String providerExtension, java.lang.Boolean hidden)
AddinLibrary(java.lang.String name, URLPath classPath, URLPath srcPath, URLPath docPath, java.lang.Boolean deployed, java.lang.Boolean forceExtInit, java.lang.String providerExtension, java.lang.Boolean hidden, URLPath endorsedDirs, URLPath endorsedSrcPath, URLPath endorsedDocPath)

Method Summary

Modifier and Type	Method and Description
java.util.Map<URLKey,oracle.javatools.exports.ExportModel<?>>	getAnnotatedClassPath() Gets a map from classpath entry to the corresponding export specification.
URLPath	getClassPath()
JLibraryDefinition	getDefaultLibraryDefinition() Deprecated. JDK based versions desupported. Use JLibrary directly.
java.util.List<oracle.javatools.exports.ExportLibrary.Dependency>	getDependencies() Gets the list of libraries that this library depends on and for each library, whether its API should be reexported.
java.lang.Boolean	getDeployedByDefault()
java.lang.String	getDescription() Gets a human readable description of this library.
URLPath	getDocPath()
URLPath	getEndorsedStandardsDirectories() Get the endorsed standards override directories associated with this library.
URLPath	getEndorsedStandardsDocPath() Get the doc path for the endorsed standards override associated with this library.
URLPath	getEndorsedStandardsSourcePath() Get the source path for the endorsed standards override associated with this library.
boolean	getForceExtensionInitialization() Determine whether or not the extension that provided the library should be initialized if the library is referenced.
javax.swing.Icon	getIcon() This implementation returns a plain document icon.
java.lang.String	getId() Gets the globally unique id of this library.
JLibraryDefinition	getLibraryDefinition(VersionNumber jdkVer) Deprecated. JDK based versions desupported. Use JLibrary directly.
java.lang.String	getLongLabel() This implementation delegates to DefaultDisplayable.getShortLabel().
java.lang.String	getName()
java.lang.String	getProviderExtensionId() Get the id of the extension that provided this library, may be null.
java.lang.String	getShortLabel() This implementation returns a place-holder String.
URLPath	getSourcePath()
boolean	isHidden() Whether the library should be hidden from the user.
void	markDirty(boolean dirty) Marks the data with the specified dirty state.
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 oracle.jdeveloper.library.AbstractLibrary

copyToImpl, equals, equalsImpl, equivalent, getDefaultClassPath, getDefaultDocPath, getDefaultSourcePath, getID, initFromLibrary, isDirty, isLocked

Methods inherited from class oracle.ide.model.DefaultElement

getAttributes, getChildren, getData, mayHaveChildren

Methods inherited from class oracle.ide.model.DefaultDisplayable

getToolTipText, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.jdeveloper.library.Library

equivalent, getDefaultClassPath, getDefaultDocPath, getDefaultSourcePath, getID, initFromLibrary

Methods inherited from interface oracle.jdeveloper.library.JPaths

isLocked

Methods inherited from interface oracle.ide.model.Displayable

getAttributedLabel, getToolTipText, toString

Constructor Detail

AddinLibrary

public AddinLibrary(java.lang.String name,
                    URLPath clsPath,
                    URLPath srcPath,
                    URLPath docPath,
                    java.lang.Boolean deployed)

AddinLibrary

public AddinLibrary(java.lang.String name,
                    URLPath clsPath,
                    URLPath srcPath,
                    URLPath docPath,
                    java.lang.Boolean deployed,
                    java.lang.Boolean forceExtInit,
                    java.lang.String providerExtension)

AddinLibrary

public AddinLibrary(java.lang.String name,
                    URLPath clsPath,
                    URLPath srcPath,
                    URLPath docPath,
                    java.lang.Boolean deployed,
                    java.lang.Boolean forceExtInit,
                    java.lang.String providerExtension,
                    java.lang.Boolean hidden)

AddinLibrary

public AddinLibrary(java.lang.String name,
                    URLPath classPath,
                    URLPath srcPath,
                    URLPath docPath,
                    java.lang.Boolean deployed,
                    java.lang.Boolean forceExtInit,
                    java.lang.String providerExtension,
                    java.lang.Boolean hidden,
                    URLPath endorsedDirs,
                    URLPath endorsedSrcPath,
                    URLPath endorsedDocPath)

AddinLibrary

public AddinLibrary(java.lang.String id,
                    java.lang.String description,
                    java.util.List<oracle.javatools.exports.ExportLibrary.Dependency> dependencies,
                    java.util.Map<URLKey,oracle.javatools.exports.ExportModel<?>> exports,
                    java.lang.String name,
                    URLPath classPath,
                    URLPath srcPath,
                    URLPath docPath,
                    java.lang.Boolean deployed,
                    java.lang.Boolean forceExtInit,
                    java.lang.String providerExtension,
                    java.lang.Boolean hidden,
                    URLPath endorsedDirs,
                    URLPath endorsedSrcPath,
                    URLPath endorsedDocPath)

Method Detail

getId

public java.lang.String getId()

Description copied from interface: ExportAwareLibrary

Gets the globally unique id of this library.

Specified by:

getId in interface ExportAwareLibrary

getDescription

public java.lang.String getDescription()

Description copied from interface: ExportAwareLibrary

Gets a human readable description of this library.

Specified by:

getDescription in interface ExportAwareLibrary

Returns:

getDependencies

public java.util.List<oracle.javatools.exports.ExportLibrary.Dependency> getDependencies()

Description copied from interface: ExportAwareLibrary

Gets the list of libraries that this library depends on and for each library, whether its API should be reexported.

Specified by:

getDependencies in interface ExportAwareLibrary

getAnnotatedClassPath

public java.util.Map<URLKey,oracle.javatools.exports.ExportModel<?>> getAnnotatedClassPath()

Description copied from interface: ExportAwareLibrary

Gets a map from classpath entry to the corresponding export specification. If a classpath entry is missing from this map, it is assumed to have an empty export model. This signature is problematic, both because of the interaction with getClassPath() and because it returns a map. I had ExportModel getAnnotation(URL) for a while, but that had its own problems, primarily not fitting the JavaBeans approach of many library implementations.

The

Specified by:

getAnnotatedClassPath in interface ExportAwareLibrary

getName

public java.lang.String getName()

Specified by:

getName in interface Library

Returns:

the Library name, or null

getClassPath

public URLPath getClassPath()

Specified by:

getClassPath in interface JPaths

Returns:

May be null.

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.

getDeployedByDefault

public java.lang.Boolean getDeployedByDefault()
                                       throws AttributeMarker

Specified by:

getDeployedByDefault in interface JLibrary

Throws:

AttributeMarker

getShortLabel

public java.lang.String getShortLabel()

Description copied from class: DefaultDisplayable

This implementation returns a place-holder String.

Specified by:

getShortLabel in interface Displayable

Overrides:

getShortLabel in class AbstractLibrary

Returns:

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

See Also:

Displayable.getShortLabel()

getLongLabel

public java.lang.String getLongLabel()

Description copied from class: DefaultDisplayable

This implementation delegates to DefaultDisplayable.getShortLabel().

Specified by:

getLongLabel in interface Displayable

Overrides:

getLongLabel in class DefaultDisplayable

Returns:

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

See Also:

Displayable.getLongLabel()

getIcon

public javax.swing.Icon getIcon()

Description copied from class: DefaultDisplayable

This implementation returns a plain document icon.

Specified by:

getIcon in interface Displayable

Overrides:

getIcon in class AbstractLibrary

Returns:

the Icon to be displayed for the Displayable.

See Also:

Displayable.getIcon()

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.

markDirty

public void markDirty(boolean dirty)

Description copied from interface: Dirtyable

Marks the data with the specified dirty state. This method is called markDirty(...) instead of setDirty(...) so that the JavaBeans Introspector will not mistakenly identify "dirty" as a JavaBean property.

Specified by:

markDirty in interface Dirtyable

Overrides:

markDirty in class AbstractLibrary

Parameters:

dirty - If true, sets the object as being dirty; if false, sets the object as being up-to-date.

Throws:

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

setClassPath

public void setClassPath(URLPath clsPath)

Specified by:

setClassPath in interface JPaths

Overrides:

setClassPath in class AbstractLibrary

Throws:

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

setDefaultClassPath

@Deprecated
public void setDefaultClassPath(URLPath clsPath)

Deprecated.

Specified by:

setDefaultClassPath in interface Library

Overrides:

setDefaultClassPath in class AbstractLibrary

Throws:

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

setDefaultDocPath

@Deprecated
public void setDefaultDocPath(URLPath docPath)

Deprecated.

Specified by:

setDefaultDocPath in interface Library

Overrides:

setDefaultDocPath in class AbstractLibrary

Throws:

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

setDefaultSourcePath

@Deprecated
public void setDefaultSourcePath(URLPath srcPath)

Deprecated.

Specified by:

setDefaultSourcePath in interface Library

Overrides:

setDefaultSourcePath in class AbstractLibrary

Throws:

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

setDocPath

public void setDocPath(URLPath docPath)

Specified by:

setDocPath in interface JPaths

Overrides:

setDocPath in class AbstractLibrary

Throws:

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

setLocked

public void setLocked(boolean isLocked)

Specified by:

setLocked in interface JPaths

Overrides:

setLocked in class AbstractLibrary

Throws:

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

setName

public void setName(java.lang.String name)

Specified by:

setName in interface Library

Overrides:

setName in class AbstractLibrary

Throws:

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

setSourcePath

public void setSourcePath(URLPath srcPath)

Specified by:

setSourcePath in interface JPaths

Overrides:

setSourcePath in class AbstractLibrary

Throws:

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

getForceExtensionInitialization

public boolean getForceExtensionInitialization()

Description copied from interface: ExtensionLibrary

Determine whether or not the extension that provided the library should be initialized if the library is referenced.

Specified by:

getForceExtensionInitialization in interface ExtensionLibrary

Returns:

true if the extension should be initialized; false otherwise

getProviderExtensionId

public java.lang.String getProviderExtensionId()

Description copied from interface: ExtensionLibrary

Get the id of the extension that provided this library, may be null.

Specified by:

getProviderExtensionId in interface ExtensionLibrary

Returns:

the id of the extension that provided this library, may be null

isHidden

public boolean isHidden()

Description copied from interface: ExtensionLibrary

Whether the library should be hidden from the user. Hidden libraries can be used, for example, to define an obsolete library to allow legacy support for older projects, but which is not available to users in new projects.

Specified by:

isHidden in interface ExtensionLibrary

Returns:

true if this library is hidden from the user, false otherwise

getEndorsedStandardsDirectories

public URLPath getEndorsedStandardsDirectories()

Description copied from interface: EndorsedStandardsOverride

Get the endorsed standards override directories associated with this library.

Specified by:

getEndorsedStandardsDirectories in interface EndorsedStandardsOverride

Returns:

the endorsed standards override directories

getEndorsedStandardsSourcePath

public URLPath getEndorsedStandardsSourcePath()

Description copied from interface: EndorsedStandardsOverride

Get the source path for the endorsed standards override associated with this library.

Specified by:

getEndorsedStandardsSourcePath in interface EndorsedStandardsOverride

Returns:

the endorsed standards override source path

getEndorsedStandardsDocPath

public URLPath getEndorsedStandardsDocPath()

Description copied from interface: EndorsedStandardsOverride

Get the doc path for the endorsed standards override associated with this library.

Specified by:

getEndorsedStandardsDocPath in interface EndorsedStandardsOverride

Returns:

the endorsed standards override doc path