net.sf.ant4eclipse.model.pdesupport.plugin
Class PluginDescriptor

java.lang.Object
  extended by net.sf.ant4eclipse.model.pdesupport.plugin.PluginDescriptor

public class PluginDescriptor
extends java.lang.Object

Encapsulates the description of a plugin.


Field Summary
static java.lang.String FRAGMENT_ATTACHMENT_ALWAYS
          FRAGMENT_ATTACHMENT_ALWAYS
static java.lang.String FRAGMENT_ATTACHMENT_NEVER
          FRAGMENT_ATTACHMENT_NEVER
static java.lang.String FRAGMENT_ATTACHMENT_RESOLVE_TIME
          FRAGMENT_ATTACHMENT_RESOLVE_TIME
 
Constructor Summary
PluginDescriptor(EclipseProject eclipseProject)
          Creates a new instance of type PluginDescriptor.
PluginDescriptor(java.io.File pluginSource)
          Creates a new instance of type PluginDescriptor.
 
Method Summary
 java.lang.String getActivator()
          Returns the activator.
 java.lang.String[] getClasspathEntries()
          Returns the classpath entries of the plugin.
 EclipseProject getEclipseProject()
          Returns the eclipse project that represents this plugin (may null).
 java.lang.String getFragmentAttachment()
          Returns how fragment attachments should be handled.
 java.lang.String getLocalization()
          Returns the localization.
 java.lang.String getName()
          Return the name of the plugin (not the symbolic name!).
 java.lang.String getPluginID()
          Returns the plugin ID which is desired by this fragment.
 java.io.File getPluginSource()
          Returns the file or directory that represents the plugin (may null).
 Version getPluginVersion()
          Returns the version of the plugin required by this fragment.
 RequiredPlugin[] getRequiredPlugins()
          Returns an array of the specified required plugins.
 java.lang.String getSymbolicName()
          Returns the symbolic name.
 java.lang.String getVendor()
          Returns the vendor of the plugin.
 Version getVersion()
          Returns the version of the plugin.
 boolean hasClasspathEntries()
          Returns whether the plugin has classpath entries.
 boolean hasRequiredPlugins()
          Returns whether the plugin has required plugins.
 boolean hasSymbolicName(java.lang.String symbolicName)
          Returns whether or not the plugin has the specified symbolic name.
 boolean isAutoStart()
          Returns whether or not the plugin should start automaticly.
 boolean isEclipseProject()
          Returns whether or not the plugin is an eclipse project.
 boolean isFragment()
          Return whether or not the plugin is a fragment.
 boolean isPluginDirectory()
          Returns whether or not the plugin is an plugin directory.
 boolean isPluginJar()
          Returns whether or not the plugin is an plugin jarfile.
 boolean isSingleton()
          Return whether or not the plugin is a singleton.
 boolean isSystemBundle()
          Returns whether the bundle is the system bundle ("system.bundle") or not.
 void setSystemBundle(boolean isSystemBundle)
           
 java.lang.String toString()
          
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

FRAGMENT_ATTACHMENT_ALWAYS

public static java.lang.String FRAGMENT_ATTACHMENT_ALWAYS
FRAGMENT_ATTACHMENT_ALWAYS


FRAGMENT_ATTACHMENT_NEVER

public static java.lang.String FRAGMENT_ATTACHMENT_NEVER
FRAGMENT_ATTACHMENT_NEVER


FRAGMENT_ATTACHMENT_RESOLVE_TIME

public static java.lang.String FRAGMENT_ATTACHMENT_RESOLVE_TIME
FRAGMENT_ATTACHMENT_RESOLVE_TIME

Constructor Detail

PluginDescriptor

public PluginDescriptor(java.io.File pluginSource)
Creates a new instance of type PluginDescriptor.

Parameters:
pluginSource - the file or directory that represents the plugin.

PluginDescriptor

public PluginDescriptor(EclipseProject eclipseProject)
Creates a new instance of type PluginDescriptor.

Parameters:
eclipseProject - the eclipse project that represents this plugin.
Method Detail

isEclipseProject

public boolean isEclipseProject()
Returns whether or not the plugin is an eclipse project.

Returns:
whether or not the plugin is an eclipse project.

isPluginDirectory

public boolean isPluginDirectory()
Returns whether or not the plugin is an plugin directory.

Returns:
whether or not the plugin is an plugin directory.

isPluginJar

public boolean isPluginJar()
Returns whether or not the plugin is an plugin jarfile.

Returns:
whether or not the plugin is an plugin jarfile.

getPluginSource

public java.io.File getPluginSource()
Returns the file or directory that represents the plugin (may null).

Returns:
the file or directory that represents the plugin (may null).

getEclipseProject

public EclipseProject getEclipseProject()
Returns the eclipse project that represents this plugin (may null).

Returns:
the eclipse project that represents this plugin (may null).

getFragmentAttachment

public java.lang.String getFragmentAttachment()
Returns how fragment attachments should be handled.

Returns:
how fragment attachments should be handled.

getActivator

public java.lang.String getActivator()
Returns the activator.

Returns:
the activator.

getPluginID

public java.lang.String getPluginID()
Returns the plugin ID which is desired by this fragment.

Returns:
The plugin ID which is desired by this fragment.

getSymbolicName

public java.lang.String getSymbolicName()
Returns the symbolic name.

Returns:
the symbolic name.

hasSymbolicName

public boolean hasSymbolicName(java.lang.String symbolicName)
Returns whether or not the plugin has the specified symbolic name.

Parameters:
symbolicName - the symbolic name.
Returns:
whether or not the plugin has the specified symbolic name.

isAutoStart

public boolean isAutoStart()
Returns whether or not the plugin should start automaticly.

Returns:
whether or not the plugin should start automaticly.

isFragment

public boolean isFragment()
Return whether or not the plugin is a fragment.

Returns:
whether or not the plugin is a fragment.

isSingleton

public boolean isSingleton()
Return whether or not the plugin is a singleton.

Returns:
whether or not the plugin is a singleton.

getLocalization

public java.lang.String getLocalization()
Returns the localization.

Returns:
the localization.

getName

public java.lang.String getName()
Return the name of the plugin (not the symbolic name!).

Returns:
the name of the plugin (not the symbolic name!).

getRequiredPlugins

public RequiredPlugin[] getRequiredPlugins()
Returns an array of the specified required plugins.

Returns:
an array of the specified required plugins.

hasRequiredPlugins

public boolean hasRequiredPlugins()
Returns whether the plugin has required plugins.

Returns:
whether the plugin has required plugins.

getClasspathEntries

public java.lang.String[] getClasspathEntries()
Returns the classpath entries of the plugin.

Returns:
the classpath entries of the plugin.

hasClasspathEntries

public boolean hasClasspathEntries()
Returns whether the plugin has classpath entries.

Returns:
whether the plugin has classpath entries.

getVendor

public java.lang.String getVendor()
Returns the vendor of the plugin.

Returns:
the vendor of the plugin.

getVersion

public Version getVersion()
Returns the version of the plugin.

Returns:
the version of the plugin.

getPluginVersion

public Version getPluginVersion()
Returns the version of the plugin required by this fragment.

Returns:
The version of the plugin required by this fragment. Maybe null.

isSystemBundle

public boolean isSystemBundle()
Returns whether the bundle is the system bundle ("system.bundle") or not.

Returns:
whether the bundle is the system bundle ("system.bundle") or not.

toString

public java.lang.String toString()

Overrides:
toString in class java.lang.Object

setSystemBundle

public void setSystemBundle(boolean isSystemBundle)
Parameters:
isSystemBundle - The isSystemBundle to set