oracle.jdeveloper.library

Class LibraryAdapter

java.lang.Object

oracle.javatools.data.HashStructureAdapter

oracle.jdeveloper.library.LibraryAdapter

All Implemented Interfaces:

Displayable, JPaths, Library, LibraryWithMacroSupport

Direct Known Subclasses:

JDKAdapter, JLibraryAdapter

public abstract class LibraryAdapter
extends HashStructureAdapter
implements LibraryWithMacroSupport

Field Summary

Fields inherited from class oracle.javatools.data.HashStructureAdapter

_hash

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
LibraryAdapter(HashStructure hash)

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	getClassPath(boolean expandMacros)
URLPath	getClassPath(Context context, boolean expandMacros) Context is ignored unless expandMacros is true; when expanding macros, certain built-in IDE macros require a context in order to evaluate correctly.
URLPath	getDefaultClassPath() Deprecated. use getClassPath()
URLPath	getDefaultDocPath() Deprecated. use getDocPath()
URLPath	getDefaultSourcePath() Deprecated. use getSourcePath()
URLPath	getDocPath()
URLPath	getDocPath(boolean expandMacros)
URLPath	getDocPath(Context context, boolean expandMacros)
javax.swing.Icon	getIcon() Returns an Icon that can be shown in association with this Displayable.
java.lang.Object	getID()
java.lang.String	getLongLabel() Returns a long label that can be displayed to the user.
java.lang.String	getName()
java.lang.String	getShortLabel() Returns a short label that can be displayed to the user.
URLPath	getSourcePath()
URLPath	getSourcePath(boolean expandMacros)
URLPath	getSourcePath(Context context, boolean expandMacros)
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 path)
void	setDefaultClassPath(URLPath path) Deprecated. use setClassPath(URLPath)
void	setDefaultDocPath(URLPath path) Deprecated. use setDocPath(URLPath)
void	setDefaultSourcePath(URLPath path) Deprecated. use setSourcePath(URLPath)
void	setDocPath(URLPath path)
void	setID(java.lang.Object id)
void	setLocked(boolean isLocked)
void	setName(java.lang.String name)
void	setSourcePath(URLPath path)
java.lang.String	toString() Returns the Short Label displayed to a user.

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

Methods inherited from interface oracle.ide.model.Displayable

getAttributedLabel

Constructor Detail

LibraryAdapter

public LibraryAdapter(HashStructure hash)

Method Detail

getClassPath

public URLPath getClassPath()

Specified by:

getClassPath in interface JPaths

Returns:

May be null.

getClassPath

public URLPath getClassPath(boolean expandMacros)

Specified by:

getClassPath in interface LibraryWithMacroSupport

getClassPath

public URLPath getClassPath(Context context,
                            boolean expandMacros)

Description copied from interface: LibraryWithMacroSupport

Context is ignored unless expandMacros is true; when expanding macros, certain built-in IDE macros require a context in order to evaluate correctly. If null is passed and the macro requires a valid context, an IllegalArgumentException will be thrown.

Specified by:

getClassPath in interface LibraryWithMacroSupport

setClassPath

public void setClassPath(URLPath path)

Specified by:

setClassPath in interface JPaths

getSourcePath

public URLPath getSourcePath()

Specified by:

getSourcePath in interface JPaths

Returns:

May be null.

getSourcePath

public URLPath getSourcePath(boolean expandMacros)

Specified by:

getSourcePath in interface LibraryWithMacroSupport

getSourcePath

public URLPath getSourcePath(Context context,
                             boolean expandMacros)

Specified by:

getSourcePath in interface LibraryWithMacroSupport

setSourcePath

public void setSourcePath(URLPath path)

Specified by:

setSourcePath in interface JPaths

getDocPath

public URLPath getDocPath()

Specified by:

getDocPath in interface JPaths

Returns:

May be null.

getDocPath

public URLPath getDocPath(boolean expandMacros)

Specified by:

getDocPath in interface LibraryWithMacroSupport

getDocPath

public URLPath getDocPath(Context context,
                          boolean expandMacros)

Specified by:

getDocPath in interface LibraryWithMacroSupport

setDocPath

public void setDocPath(URLPath path)

Specified by:

setDocPath in interface JPaths

isLocked

public boolean isLocked()

Specified by:

isLocked in interface JPaths

setLocked

public void setLocked(boolean isLocked)

Specified by:

setLocked in interface JPaths

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.

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()

getName

public java.lang.String getName()

Specified by:

getName in interface Library

Returns:

the Library name, or null

setName

public void setName(java.lang.String name)

Specified by:

setName in interface Library

getID

public java.lang.Object getID()

Specified by:

getID in interface Library

Returns:

the Library id as a String or null

setID

public void setID(java.lang.Object id)

getDefaultClassPath

@Deprecated
public URLPath getDefaultClassPath()

Deprecated. use getClassPath()

Specified by:

getDefaultClassPath in interface Library

setDefaultClassPath

@Deprecated
public void setDefaultClassPath(URLPath path)

Deprecated. use setClassPath(URLPath)

Specified by:

setDefaultClassPath in interface Library

getDefaultSourcePath

@Deprecated
public URLPath getDefaultSourcePath()

Deprecated. use getSourcePath()

Specified by:

getDefaultSourcePath in interface Library

setDefaultSourcePath

@Deprecated
public void setDefaultSourcePath(URLPath path)

Deprecated. use setSourcePath(URLPath)

Specified by:

setDefaultSourcePath in interface Library

getDefaultDocPath

@Deprecated
public URLPath getDefaultDocPath()

Deprecated. use getDocPath()

Specified by:

getDefaultDocPath in interface Library

setDefaultDocPath

@Deprecated
public void setDefaultDocPath(URLPath path)

Deprecated. use setDocPath(URLPath)

Specified by:

setDefaultDocPath in interface Library