oracle.jdeveloper.library
Class AddinLibraryList

java.lang.Object
  oracle.jdeveloper.library.AddinLibraryList

All Implemented Interfaces:

Displayable, LibraryList

public final class AddinLibraryList
extends java.lang.Object
implements LibraryList

Provides access to libraries registered by extensions.

Thread Safety: Instances of this class are thread-safe.

Since:

9.0.2

Field Summary

Fields inherited from interface oracle.jdeveloper.library.LibraryList

JDK_LIST_PROPERTY, LIB_LIST_PROPERTY, LISTNAME_PROPERTY, TRANSIENT_PROPERTY

Method Summary

void	addAlias(java.lang.String aliasName, java.lang.String libName) Deprecated. since 11.1.1 with no replacement. Aliases are registered in the libraries hook of the extension manifest (extension.xml). This method does nothing.
JDK	findJDK(java.lang.Object id) Finds the JDK definition that matches the specified name.
JLibrary	findLibrary(java.lang.Object id) Finds the JLibrary that matches the specified id.
javax.swing.Icon	getIcon() Returns an Icon that can be shown in association with this Displayable.
java.util.List	getJdkList() Retrieves a List of JDK definitions contained in this LibraryList.
java.util.List	getLibraryList() Retrieves a List of JLibrary definitions contained in this LibraryList.
java.lang.String	getListName() Retrieves the name of this LibraryList.
java.lang.String	getLongLabel() Returns a long label that can be displayed to the user.
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.
boolean	isTransient() Whether this list is transient (not-persistent).
JDK	loadJDK(java.lang.String name, URLPath clsPath, URLPath srcPath, URLPath docPath, java.net.URL exeURL, VersionNumber version, java.net.URL sdkBinDir) Deprecated. since 11.1.1.0.0. This method should be called only by the internal implementation of JLibraryManager, and is not intended for general use.
JLibrary	loadLibrary(java.lang.String name, URLPath clsPath, URLPath srcPath, URLPath docPath, java.lang.Boolean isDeployed) Deprecated. since 11.1.1.0.0 use registerLibrary(AddinLibrary).
void	registerLibrary(AddinLibrary library) Registers an extension library programmatically.
java.lang.String	toString() Returns the Short Label displayed to a user.

Methods inherited from class java.lang.Object

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

Method Detail

addAlias

public void addAlias(java.lang.String aliasName,
                     java.lang.String libName)

Deprecated. since 11.1.1 with no replacement. Aliases are registered in the libraries hook of the extension manifest (extension.xml). This method does nothing.

registerLibrary

public void registerLibrary(AddinLibrary library)

Registers an extension library programmatically.

Note that the preferred way to register extension libraries is to use the <library> hook in extension.xml. Extension writers should generally avoid calling this method.

Parameters:

library - a library to install.

Throws:

java.lang.NullPointerException - if library is null.

Since:

11.1.1.0.0

loadLibrary

public JLibrary loadLibrary(java.lang.String name,
                            URLPath clsPath,
                            URLPath srcPath,
                            URLPath docPath,
                            java.lang.Boolean isDeployed)

Deprecated. since 11.1.1.0.0 use registerLibrary(AddinLibrary).

loadJDK

public JDK loadJDK(java.lang.String name,
                   URLPath clsPath,
                   URLPath srcPath,
                   URLPath docPath,
                   java.net.URL exeURL,
                   VersionNumber version,
                   java.net.URL sdkBinDir)

Deprecated. since 11.1.1.0.0. This method should be called only by the internal implementation of JLibraryManager, and is not intended for general use.

findJDK

public JDK findJDK(java.lang.Object id)

Description copied from interface: LibraryList

Finds the JDK definition that matches the specified name.

Specified by:

findJDK in interface LibraryList

Parameters:

id - the id of the JDK definition

Returns:

the JDK representing the JDK definition.

findLibrary

public JLibrary findLibrary(java.lang.Object id)

Description copied from interface: LibraryList

Finds the JLibrary that matches the specified id.

Specified by:

findLibrary in interface LibraryList

getJdkList

public java.util.List getJdkList()

Description copied from interface: LibraryList

Retrieves a List of JDK definitions contained in this LibraryList.

Specified by:

getJdkList in interface LibraryList

getLibraryList

public java.util.List getLibraryList()

Description copied from interface: LibraryList

Retrieves a List of JLibrary definitions contained in this LibraryList.

Specified by:

getLibraryList in interface LibraryList

getListName

public java.lang.String getListName()

Description copied from interface: LibraryList

Retrieves the name of this LibraryList.

Specified by:

getListName in interface LibraryList

isTransient

public boolean isTransient()

Description copied from interface: LibraryList

Whether this list is transient (not-persistent). Transient lists cannot have new children created by the user

Specified by:

isTransient in interface LibraryList

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.

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.

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.

toString

public java.lang.String toString()

Description copied from interface: Displayable

Returns the Short Label displayed to a user. This overrides the toString method in java.lang.Object.

Implementors of the Displayable interface should override this as appropriate. The default implementation is the same as getShortLabel

Specified by:

toString in interface Displayable

Overrides:

toString in class java.lang.Object

See Also:

Object.toString(), Displayable.getShortLabel()