oracle.jdeveloper.library

Class ExternalLibrary

java.lang.Object

oracle.ide.model.Node

oracle.jdeveloper.library.LibraryDataNode

oracle.jdeveloper.library.ExternalLibrary

All Implemented Interfaces:

Displayable, Element, LazyLoadable, Locatable, Subject, Dirtyable, JPaths, Library

Direct Known Subclasses:

JDKNode, JLibraryNode

public abstract class ExternalLibrary
extends LibraryDataNode
implements Library

Field Summary

Fields inherited from class oracle.ide.model.Node

LOG_READONLY

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
ExternalLibrary() Default constructor.
ExternalLibrary(java.net.URL url)

Method Summary

Modifier and Type	Method and Description
boolean	equivalent(Library lib) Determine whether the given Library is equivalent to this one with respect to the values of its public properties other than name.
protected void	fireChangeEvent(java.lang.String property, java.lang.Object oldValue, java.lang.Object newValue)
URLPath	getClassPath() Get the path where classes can be found.
URLPath	getDefaultClassPath() Deprecated. use getClassPath
URLPath	getDefaultDocPath() Deprecated. use getDocPath
URLPath	getDefaultSourcePath() Deprecated. use getSourcePath
URLPath	getDocPath() Get the path where documentation can be found.
protected abstract java.lang.String	getExtension()
javax.swing.Icon	getIcon() Displayable interface method.
java.lang.Object	getID()
java.lang.String	getName()
java.lang.String	getShortLabel() Displayable interface method.
URLPath	getSourcePath() Get the path where sources can be found.
void	initFromLibrary(Library lib) Initialize all public properties, other than name, from the Library provided.
boolean	isLocked() Determine if paths are locked or not.
void	setClassPath(URLPath path) Set the path where classes can be found.
void	setDefaultClassPath(URLPath clsPath) Deprecated. use setClassPath
void	setDefaultDocPath(URLPath docPath) Deprecated. use setDocPath
void	setDefaultSourcePath(URLPath srcPath) Deprecated. use setSourcePath
void	setDocPath(URLPath path) Set the path where documentation can be found.
void	setLocked(boolean locked) Update the lock of the paths.
void	setName(java.lang.String name)
void	setSourcePath(URLPath path) Set the path where sources can be found.
java.lang.String	toString() Returns the Short Label displayed to a user.

Methods inherited from class oracle.jdeveloper.library.LibraryDataNode

getObjectStoreTarget, getURL, newObjectStore, openImpl, saveImpl

Methods inherited from class oracle.ide.model.Node

addNodeListener, addNodeListenerForType, addNodeListenerForTypeHierarchy, addWeakNodeListener, attach, beginThreadNodeUsageCycle, bypassNodeCreationsDuringDelete, callUnderReadLock, callUnderWriteLock, close, closeImpl, createSubject, delete, deleteImpl, detach, endThreadNodeUsage, endThreadNodeUsageCycle, ensureOpen, equalsImpl, getAttributes, getChildren, getData, getInputStream, getLongLabel, getSubject, getTimestamp, getTimestampLoadedUnsafe, getToolTipText, getTransientProperties, getUnmodifiedTimestamp, isDirty, isLoaded, isLockHeld, isMigrating, isNew, isOpen, isReadLocked, isReadLockHeld, isReadOnly, isReadOrWriteLocked, isTrackedInNodeCache, isTrackingThreadNodeUsage, isWriteLocked, isWriteLockHeld, lockCount, markDirty, markDirtyImpl, mayHaveChildren, nodeLock, notifyObservers, open, readLock, readLockCount, readLockInterruptibly, readUnlock, refreshTimestamp, removeNodeListener, removeNodeListenerForType, removeNodeListenerForTypeHierarchy, removeWeakNodeListener, rename, renameImpl, reportOpenException, revert, revertImpl, runUnderReadLock, runUnderWriteLock, save, setEventLog, setMigrating, setOpen, setReadOnly, setTimestampDirectly, setURL, tryRunUnderReadLock, tryRunUnderWriteLock, unsetMigrating, upgradeLock, upgradeUnlock, urlReadOnlyChanged, writeLock, writeLockCount, writeLockInterruptibly, writeUnlock

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.ide.model.Displayable

getAttributedLabel, getLongLabel, getToolTipText

Constructor Detail

ExternalLibrary

public ExternalLibrary()

Default constructor. Required for JavaBean status.

ExternalLibrary

public ExternalLibrary(java.net.URL url)

Method Detail

getExtension

protected abstract java.lang.String getExtension()

getDefaultClassPath

@Deprecated
public URLPath getDefaultClassPath()
                                        throws TransientMarker

Deprecated. use getClassPath

Specified by:

getDefaultClassPath in interface Library

Throws:

TransientMarker

setDefaultClassPath

@Deprecated
public void setDefaultClassPath(URLPath clsPath)

Deprecated. use setClassPath

Specified by:

setDefaultClassPath in interface Library

getDefaultSourcePath

@Deprecated
public URLPath getDefaultSourcePath()
                                         throws TransientMarker

Deprecated. use getSourcePath

Specified by:

getDefaultSourcePath in interface Library

Throws:

TransientMarker

setDefaultSourcePath

@Deprecated
public void setDefaultSourcePath(URLPath srcPath)

Deprecated. use setSourcePath

Specified by:

setDefaultSourcePath in interface Library

getDefaultDocPath

@Deprecated
public URLPath getDefaultDocPath()
                                      throws TransientMarker

Deprecated. use getDocPath

Specified by:

getDefaultDocPath in interface Library

Throws:

TransientMarker

setDefaultDocPath

@Deprecated
public void setDefaultDocPath(URLPath docPath)

Deprecated. use setDocPath

Specified by:

setDefaultDocPath in interface Library

getClassPath

public URLPath getClassPath()

Description copied from interface: JPaths

Get the path where classes can be found.

Specified by:

getClassPath in interface JPaths

Returns:

A URLPath which may be null or empty.

setClassPath

public void setClassPath(URLPath path)

Description copied from interface: JPaths

Set the path where classes can be found.

Specified by:

setClassPath in interface JPaths

Parameters:

path - The path

getSourcePath

public URLPath getSourcePath()

Description copied from interface: JPaths

Get the path where sources can be found.

Specified by:

getSourcePath in interface JPaths

Returns:

A URLPath which may be null or empty.

setSourcePath

public void setSourcePath(URLPath path)

Description copied from interface: JPaths

Set the path where sources can be found.

Specified by:

setSourcePath in interface JPaths

Parameters:

path - The path

getDocPath

public URLPath getDocPath()

Description copied from interface: JPaths

Get the path where documentation can be found.

Specified by:

getDocPath in interface JPaths

Returns:

A URLPath which may be null or empty.

setDocPath

public void setDocPath(URLPath path)

Description copied from interface: JPaths

Set the path where documentation can be found.

Specified by:

setDocPath in interface JPaths

Parameters:

path - The path

isLocked

public boolean isLocked()

Description copied from interface: JPaths

Determine if paths are locked or not. Derived classes can give a more specific meaning, such as locked means read-only.

Specified by:

isLocked in interface JPaths

Returns:

True if the paths are locked

setLocked

public void setLocked(boolean locked)

Description copied from interface: JPaths

Update the lock of the paths. Derived classes can give a more specific meaning, such as locked means read-only.

Specified by:

setLocked in interface JPaths

Parameters:

locked - True if the paths should be locked

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

equivalent

public boolean equivalent(Library lib)

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:

lib - the Library against which to test for equivalence.

Returns:

true if all public properties are equal.

initFromLibrary

public void initFromLibrary(Library lib)

Description copied from interface: Library

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

Specified by:

initFromLibrary in interface Library

Parameters:

lib - the Library from which to fetch property values.

getShortLabel

public java.lang.String getShortLabel()

Description copied from class: Node

Displayable interface method. The Node class returns the file name part of the currently set URL. If the currently set URL is null, then this method returns "<null>".

Specified by:

getShortLabel in interface Displayable

Overrides:

getShortLabel in class Node

Returns:

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

getIcon

public javax.swing.Icon getIcon()

Description copied from class: Node

Displayable interface method. The Node class returns a generic icon.

Specified by:

getIcon in interface Displayable

Overrides:

getIcon in class Node

Returns:

the Icon to be displayed for the 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 Node

See Also:

Object.toString(), Displayable.getShortLabel()

fireChangeEvent

protected void fireChangeEvent(java.lang.String property,
                               java.lang.Object oldValue,
                               java.lang.Object newValue)