oracle.jdeveloper.library
Class JLibrary

java.lang.Object
  oracle.ide.model.DefaultDisplayable
      oracle.ide.model.DefaultElement
          oracle.ide.model.DataElement
              oracle.jdeveloper.library.AbstractLibrary
                  oracle.jdeveloper.library.JLibrary

All Implemented Interfaces:

Copyable, Data, Dirtyable, Displayable, Element, Library, SubDirtyable, Subject

public class JLibrary

extends AbstractLibrary

Encapsulates the notion of a library as it is used within JDeveloper.

Field Summary

Fields inherited from interface oracle.jdeveloper.library.Library

LIBRARY_NAME_PROPERTY

Fields inherited from interface oracle.ide.addin.Subject

OBJECT_MODIFIED

Constructor Summary

JLibrary()
Default constructor.

JLibrary(JLibrary jLibrary)
Copy constructor.

Method Summary

void	addLibraryDefinition(JLibraryDefinition newDef)
java.lang.Object	copyTo(java.lang.Object object) Copies the internal state of this object to the specified copy.
protected void	copyToImpl(JLibrary copy)
boolean	equals(java.lang.Object obj)
protected boolean	equalsImpl(JLibrary other)
LibraryList	getContainingList()
URLPath	getDefaultClassPath()
URLPath	getDefaultDocPath()
JLibraryDefinition	getDefaultLibraryDefinition()
URLPath	getDefaultSourcePath()
java.util.List	getDefinitionList()
JLibraryDefinition	getLibraryDefinition(VersionNumber jdkVer)
void	removeLibraryDefinition(JLibraryDefinition def)
void	setDefaultClassPath(URLPath clsPath)
void	setDefaultDocPath(URLPath docPath)
void	setDefaultLibraryDefinition(JLibraryDefinition def)
void	setDefaultSourcePath(URLPath srcPath)
void	setDefinitionList(java.util.List defList)
void	setName(java.lang.String name)

Methods inherited from class oracle.jdeveloper.library.AbstractLibrary

attach, copyToImpl, detach, equalsImpl, getName, getOwner, getShortLabel, isDirty, isLocked, markDirty, notifyObservers, setLocked, setOwner

Methods inherited from class oracle.ide.model.DefaultElement

getAttributes, getChildren, getData, mayHaveChildren

Methods inherited from class oracle.ide.model.DefaultDisplayable

getIcon, getLongLabel, getToolTipText, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.ide.model.Element

getAttributes, getChildren, mayHaveChildren

Methods inherited from interface oracle.ide.model.Data

getData

Methods inherited from interface oracle.ide.model.Displayable

getIcon, getLongLabel, getToolTipText, toString

Constructor Detail

JLibrary

public JLibrary()

Default constructor. Required for JavaBean status.

JLibrary

public JLibrary(JLibrary jLibrary)

Copy constructor.

Method Detail

copyTo

public java.lang.Object copyTo(java.lang.Object object)

Description copied from interface: Copyable

Copies the internal state of this object to the specified copy. If copy is null, then this method should create a new instance of this class and proceed to copy the internal state to the newly created object. Generally, only the persistent state of the object should be copied, but whether or not it is appropriate to copy transient properties is at the discretion of the individual implementor.

Regardless of whether the copy occurs to an existing object or to a newly created object, the return value is object to which this object's state was copied.

There is a standard implementation pattern for the copyTo method that helps avoid problems that arise when a Copyable object is subclassed. The pattern is:

public Object copyTo( Object target )
{
final <this_class> copy =
target != null ? (<this_class>) target : new <this_class>();
copyToImpl( copy );
return copy;
} protected final void copyToImpl( <this_class> copy ) { super.copyToImpl( copy ); // if necessary // put code here for copying the properties of <this_class> }

The parameter passed into the copyToImpl method is the same type of this class. The responsibility of copyToImpl is to copy the state of this class through direct access of the fields. The copyToImpl method should not use getters and setters since these may be overridden, causing the state of this class to be incompletely copied.

Parameters:

object - The target object to which the state of this object should be copied. If target is null, then the copyTo method will return a new instance of this class.

Returns:

The object to which the state of this object was copied. If the target was non-null, then the return value is the same as the target object that was passed in; otherwise, the return value is a new instance of this class.

copyToImpl

protected final void copyToImpl(JLibrary copy)

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class AbstractLibrary

equalsImpl

protected boolean equalsImpl(JLibrary other)

setName

public void setName(java.lang.String name)
             throws java.lang.IllegalStateException

Specified by:

setName in interface Library

Overrides:

setName in class AbstractLibrary

Throws:

java.lang.IllegalStateException

getDefaultLibraryDefinition

public JLibraryDefinition getDefaultLibraryDefinition()

setDefaultLibraryDefinition

public void setDefaultLibraryDefinition(JLibraryDefinition def)

getDefinitionList

public java.util.List getDefinitionList()

setDefinitionList

public void setDefinitionList(java.util.List defList)

getDefaultClassPath

public URLPath getDefaultClassPath()
                            throws TransientMarker

Throws:

TransientMarker

setDefaultClassPath

public void setDefaultClassPath(URLPath clsPath)

getDefaultSourcePath

public URLPath getDefaultSourcePath()
                             throws TransientMarker

Throws:

TransientMarker

setDefaultSourcePath

public void setDefaultSourcePath(URLPath srcPath)

getDefaultDocPath

public URLPath getDefaultDocPath()
                          throws TransientMarker

Throws:

TransientMarker

setDefaultDocPath

public void setDefaultDocPath(URLPath docPath)

getLibraryDefinition

public JLibraryDefinition getLibraryDefinition(VersionNumber jdkVer)

addLibraryDefinition

public void addLibraryDefinition(JLibraryDefinition newDef)

removeLibraryDefinition

public void removeLibraryDefinition(JLibraryDefinition def)

getContainingList

public LibraryList getContainingList()