Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference
11g Release 1 (11.1.1.5.0)

E13403-06


oracle.jdeveloper.library
Class AddinLibrary

java.lang.Object
  extended by oracle.ide.model.DefaultDisplayable
      extended by oracle.ide.model.DefaultElement
          extended by oracle.jdeveloper.library.LibraryElement
              extended by oracle.jdeveloper.library.AbstractLibrary
                  extended by oracle.jdeveloper.library.AddinLibrary

All Implemented Interfaces:
Displayable, Element, Dirtyable, JLibrary, JLibraryDefinition, JPaths, Library

public final class AddinLibrary
extends AbstractLibrary
implements JLibrary

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
AddinLibrary(java.lang.String name, URLPath clsPath, URLPath srcPath, URLPath docPath, java.lang.Boolean deployed)
           

 

Method Summary
 URLPath getClassPath()
           
 JLibraryDefinition getDefaultLibraryDefinition()
          Deprecated. JDK based versions desupported. Use JLibrary directly.
 java.lang.Boolean getDeployedByDefault()
           
 URLPath getDocPath()
           
 javax.swing.Icon getIcon()
          This implementation returns a plain document icon.
 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 getShortLabel()
          This implementation returns a place-holder String.
 URLPath getSourcePath()
           
 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
getToolTipText, toString

 

Constructor Detail

AddinLibrary

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

Method Detail

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

public JLibraryDefinition getDefaultLibraryDefinition()
Deprecated. JDK based versions desupported. Use JLibrary directly.
Specified by:
getDefaultLibraryDefinition in interface JLibrary

getLibraryDefinition

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

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

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

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.

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference
11g Release 1 (11.1.1.5.0)

E13403-06


Copyright © 1997, 2011, Oracle. All rights reserved.