com.ibm.are.plugin
Class PluginData

java.lang.Object
  extended by com.ibm.are.core.ElementData
      extended by com.ibm.are.plugin.PluginData

public final class PluginData
extends com.ibm.are.core.ElementData

The PluginData class represents a set of data that is specific to classes that implement the Plugin interface. The fields in this class are initialized by the Application Runtime Expert only if you are using a standard facility to run a plugin. The two standard facilities that will initialize these fields are:

  1. Specifying a plugin name on the command line
  2. Using the PluginRunnerService

Elements are free to mutate data in this class. However, any changes made to the mode field should be done with great care.

Version:
1.0
Author:
IBM

Field Summary
static java.lang.String COPYRIGHT
          Copyright for class bytecode
 
Fields inherited from class com.ibm.are.core.ElementData
currentState, parameters, sourceJarFile, standardOut
 
Constructor Summary
PluginData()
          Constructs an empty PluginData object
PluginData(com.ibm.are.core.ElementData dataToCopy)
          Copy constructor.
 
Method Summary
 java.util.logging.Logger getLogger()
          Retrieves a logger that can be used for logging events
 void setLogger(java.util.logging.Logger appLogger)
          Sets the logger to be used for logging events
 
Methods inherited from class com.ibm.are.core.ElementData
addParameter, addParameter, getParameter, getParameters, getSourceJarFile, getStandardOut, getState, numberOfParameters, removeParameter, setSourceJarFile, setStandardOut, setState
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
Copyright for class bytecode

See Also:
Constant Field Values
Constructor Detail

PluginData

public PluginData()
Constructs an empty PluginData object


PluginData

public PluginData(com.ibm.are.core.ElementData dataToCopy)
Copy constructor. Note that this constructor performs a deep copy of the input object.

Parameters:
dataToCopy - The element data to copy
Method Detail

getLogger

public java.util.logging.Logger getLogger()
Retrieves a logger that can be used for logging events

Returns:
A logger

setLogger

public void setLogger(java.util.logging.Logger appLogger)
Sets the logger to be used for logging events

Parameters:
appLogger - The logger to be used