xdoclet

Class DocletContext

public class DocletContext extends Object

Version: $Revision: 1.17 $

Author: Ara Abrahamian (ara_e@email.com)

UNKNOWN: June 19, 2001

Constructor Summary
DocletContext(String destDir, String mergeDir, String excludedTags, SubTask[] subTasks, Hashtable properties, HashMap configs, boolean force, boolean verbose, String addedTags)
Describe what the DocletContext constructor does
Method Summary
SubTaskgetActiveSubTask()
Gets the ActiveSubTask attribute of the DocletContext object
StringgetAddedTags()
ObjectgetConfigParam(String name)
Gets the ConfigParam attribute of the DocletContext object
StringgetDestDir()
Gets the DestDir attribute of the DocletContext object
StringgetExcludedTags()
Gets the ExcludedTags attribute of the DocletContext object
static DocletContextgetInstance()
Gets the Instance attribute of the DocletContext class
StringgetMergeDir()
Gets the MergeDir attribute of the DocletContext object
MapgetProperties()
Gets the Properties attribute of the DocletContext object
StringgetProperty(String name)
Gets the Property attribute of the DocletContext object
SubTaskgetSubTaskBy(String subtaskName)
Gets the SubTaskBy attribute of the DocletContext object
SubTask[]getSubTasks()
Gets the SubTasks attribute of the DocletContext object
booleanisForce()
Gets the Force attribute of the DocletContext object.
booleanisSubTaskDefined(String subtaskName)
Gets the SubTaskDefined attribute of the DocletContext object
booleanisVerbose()
Gets the Verbose attribute of the DocletContext object.
voidsetActiveSubTask(SubTask activeSubTask)
Sets the ActiveSubTask attribute of the DocletContext object
static voidsetSingleInstance(DocletContext singleInstance)
Sets the SingleInstance attribute of the DocletContext class

Constructor Detail

DocletContext

public DocletContext(String destDir, String mergeDir, String excludedTags, SubTask[] subTasks, Hashtable properties, HashMap configs, boolean force, boolean verbose, String addedTags)
Describe what the DocletContext constructor does

Parameters: destDir Describe what the parameter does mergeDir Describe what the parameter does excludedTags Describe what the parameter does subTasks Describe what the parameter does properties Describe what the parameter does configs Describe what the parameter does force Describe what the parameter does verbose addedTags

Method Detail

getActiveSubTask

public SubTask getActiveSubTask()
Gets the ActiveSubTask attribute of the DocletContext object

Returns: The ActiveSubTask value

getAddedTags

public String getAddedTags()

getConfigParam

public Object getConfigParam(String name)
Gets the ConfigParam attribute of the DocletContext object

Parameters: name Describe what the parameter does

Returns: The ConfigParam value

getDestDir

public String getDestDir()
Gets the DestDir attribute of the DocletContext object

Returns: The DestDir value

getExcludedTags

public String getExcludedTags()
Gets the ExcludedTags attribute of the DocletContext object

Returns: The ExcludedTags value

getInstance

public static DocletContext getInstance()
Gets the Instance attribute of the DocletContext class

Returns: The Instance value

getMergeDir

public String getMergeDir()
Gets the MergeDir attribute of the DocletContext object

Returns: The MergeDir value

getProperties

public Map getProperties()
Gets the Properties attribute of the DocletContext object

Returns: The Properties value

getProperty

public String getProperty(String name)
Gets the Property attribute of the DocletContext object

Parameters: name Describe what the parameter does

Returns: The Property value

getSubTaskBy

public SubTask getSubTaskBy(String subtaskName)
Gets the SubTaskBy attribute of the DocletContext object

Parameters: subtaskName Describe what the parameter does

Returns: The SubTaskBy value

getSubTasks

public SubTask[] getSubTasks()
Gets the SubTasks attribute of the DocletContext object

Returns: The SubTasks value

isForce

public boolean isForce()
Gets the Force attribute of the DocletContext object.

Returns: The Force value

isSubTaskDefined

public boolean isSubTaskDefined(String subtaskName)
Gets the SubTaskDefined attribute of the DocletContext object

Parameters: subtaskName Describe what the parameter does

Returns: The SubTaskDefined value

isVerbose

public boolean isVerbose()
Gets the Verbose attribute of the DocletContext object.

Returns: The Verbose value

setActiveSubTask

public void setActiveSubTask(SubTask activeSubTask)
Sets the ActiveSubTask attribute of the DocletContext object

Parameters: activeSubTask The new ActiveSubTask value

setSingleInstance

public static void setSingleInstance(DocletContext singleInstance)
Sets the SingleInstance attribute of the DocletContext class

Parameters: singleInstance The new SingleInstance value