Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

javax.ide.extension.spi
Class DefaultExtension  view DefaultExtension download DefaultExtension.java

java.lang.Object
  extended byjavax.ide.extension.spi.DefaultExtension
All Implemented Interfaces:
java.lang.Comparable, javax.ide.extension.Extension, javax.ide.Identifiable

public final class DefaultExtension
extends java.lang.Object
implements javax.ide.extension.Extension, javax.ide.Identifiable, java.lang.Comparable

This class maintains general information about an extension. Information gathered from the extension manifest is stored in this class. Such information include the extension's id, owner, version information, etc..

IDE providers can use this class to to record the extension information section of the extension manifest.


Field Summary
private  javax.ide.net.URIPath _classpath
           
private  java.util.Collection _dependencies
           
private  javax.ide.util.Version _edkVersion
           
private  java.lang.String _id
           
private  java.lang.String _name
           
private  java.lang.String _owner
           
private  javax.ide.extension.PlatformInfo _platformInfo
           
private  ExtensionSource _source
           
private  javax.ide.util.Version _version
           
 
Constructor Summary
DefaultExtension()
          Default constructor.
DefaultExtension(java.lang.String id)
           
 
Method Summary
 void addDependency(javax.ide.extension.ExtensionDependency dependency)
          Set a list of javax.ide.extension.Extension identifiers this extension depends on.
 int compareTo(java.lang.Object o)
          Compare two extensions on their names.
 javax.ide.net.URIPath getClassPath()
          Get an additional classpath where classes used by this extension can be found.
 java.util.Collection getDependencies()
          Gets a collection of javax.ide.extension.ExtensionDependency objects, one for each dependency this extension has on another extension.
 javax.ide.util.Version getEDKVersion()
          This method is called by an IDE to inquire about the version of the Extenstion Development Kit (EDK) used in its implementation.
 java.lang.String getID()
          Gets this object's unique identifier.
 java.lang.String getName()
          Get the name of this extension.
 java.lang.String getOwner()
          Get the extension owner name.
 javax.ide.extension.PlatformInfo getPlatformInfo()
          This method is called by an IDE to inquire about platform specific information that must be supported by the IDE for this extension to work.
 ExtensionSource getSource()
           
 javax.ide.util.Version getVersion()
          Get the extension version information.
 void setClassPath(javax.ide.net.URIPath classpath)
          Set an additional classpath where classes used by this extension can be found.
 void setEDKVersion(javax.ide.util.Version edkVersion)
          Set the EDK version.
 void setName(java.lang.String name)
          Set the name of this extension.
 void setOwner(java.lang.String owner)
          Set the extension owner name.
 void setPlatformInfo(javax.ide.extension.PlatformInfo info)
          Set the platform specific info required for this extension to work.
 void setSource(ExtensionSource source)
           
 void setVersion(javax.ide.util.Version version)
          Set the extension version information.
 java.lang.String toString()
          Convert this Object to a human-readable String.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

_id

private java.lang.String _id

_name

private java.lang.String _name

_version

private javax.ide.util.Version _version

_edkVersion

private javax.ide.util.Version _edkVersion

_owner

private java.lang.String _owner

_dependencies

private java.util.Collection _dependencies

_classpath

private javax.ide.net.URIPath _classpath

_platformInfo

private javax.ide.extension.PlatformInfo _platformInfo

_source

private ExtensionSource _source
Constructor Detail

DefaultExtension

public DefaultExtension()
Default constructor.


DefaultExtension

public DefaultExtension(java.lang.String id)
Method Detail

setSource

public void setSource(ExtensionSource source)

getSource

public ExtensionSource getSource()

getID

public java.lang.String getID()
Description copied from interface: javax.ide.Identifiable
Gets this object's unique identifier.

Specified by:
getID in interface javax.ide.Identifiable

getName

public java.lang.String getName()
Description copied from interface: javax.ide.extension.Extension
Get the name of this extension. The name should not include the extension version label.

Specified by:
getName in interface javax.ide.extension.Extension

getOwner

public java.lang.String getOwner()
Description copied from interface: javax.ide.extension.Extension
Get the extension owner name.

Specified by:
getOwner in interface javax.ide.extension.Extension

getVersion

public javax.ide.util.Version getVersion()
Description copied from interface: javax.ide.extension.Extension
Get the extension version information.

Specified by:
getVersion in interface javax.ide.extension.Extension

getEDKVersion

public javax.ide.util.Version getEDKVersion()
Description copied from interface: javax.ide.extension.Extension
This method is called by an IDE to inquire about the version of the Extenstion Development Kit (EDK) used in its implementation. An IDE can decide not to load this extension if they don't yet support the EDK version returned. If null is returned, the IDE will not load the extension.

Specified by:
getEDKVersion in interface javax.ide.extension.Extension

getPlatformInfo

public javax.ide.extension.PlatformInfo getPlatformInfo()
Description copied from interface: javax.ide.extension.Extension
This method is called by an IDE to inquire about platform specific information that must be supported by the IDE for this extension to work. For example, the extension platform information may indicate the it requires swing to work.

Specified by:
getPlatformInfo in interface javax.ide.extension.Extension

getDependencies

public java.util.Collection getDependencies()
Description copied from interface: javax.ide.extension.Extension
Gets a collection of javax.ide.extension.ExtensionDependency objects, one for each dependency this extension has on another extension.

Specified by:
getDependencies in interface javax.ide.extension.Extension

getClassPath

public javax.ide.net.URIPath getClassPath()
Description copied from interface: javax.ide.extension.Extension
Get an additional classpath where classes used by this extension can be found.

Specified by:
getClassPath in interface javax.ide.extension.Extension

setName

public void setName(java.lang.String name)
Set the name of this extension. The name should not include the extension version label.


setOwner

public void setOwner(java.lang.String owner)
Set the extension owner name.


setVersion

public void setVersion(javax.ide.util.Version version)
Set the extension version information.


setEDKVersion

public void setEDKVersion(javax.ide.util.Version edkVersion)
Set the EDK version.


setPlatformInfo

public void setPlatformInfo(javax.ide.extension.PlatformInfo info)
Set the platform specific info required for this extension to work.


addDependency

public void addDependency(javax.ide.extension.ExtensionDependency dependency)
Set a list of javax.ide.extension.Extension identifiers this extension depends on.


setClassPath

public void setClassPath(javax.ide.net.URIPath classpath)
Set an additional classpath where classes used by this extension can be found.


toString

public java.lang.String toString()
Description copied from class: java.lang.Object
Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() 55 and such.

It is typical, but not required, to ensure that this method never completes abruptly with a java.lang.RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).


compareTo

public int compareTo(java.lang.Object o)
Compare two extensions on their names.

Specified by:
compareTo in interface java.lang.Comparable