com.ibm.dtfj.analyzer.helpers
Class AllEnvVars

java.lang.Object
  extended by TranslatableAnalyzer
      extended by com.ibm.dtfj.analyzer.base.SimpleAnalyzerBean
          extended by com.ibm.dtfj.analyzer.helpers.AllEnvVars
All Implemented Interfaces:
IAnalyzerBase, IReport, IWrapper

public class AllEnvVars
extends SimpleAnalyzerBean

Print and query the list of all environment variables within a DTFJ ImageProcess.


Constructor Summary
AllEnvVars()
          Null constructor for use as JavaBean
 
Method Summary
 java.lang.String getEnvVar(java.lang.String key)
          Get the value of an environment variable
static AllEnvVars getInstance(IAnalyzerContext context, com.ibm.dtfj.image.ImageProcess parent)
          Find the AllEnvVars bean instance associated with a given parent ImageProcess (create it if necessary)
 IAnalysisReport produceReport()
          Generate a report which will be encapsulated in the IAnalysisReport object for later use by some formatter.
 void setParent(java.lang.Object parent)
          Set the parent ImageProcess underlying this analyzer bean.
 
Methods inherited from class com.ibm.dtfj.analyzer.base.SimpleAnalyzerBean
allocateReport, allocateReportOptions, allocateSecondaryReport, getCachingPriority, getCategories, getContext, getIdentityString, getInstance, getLogger, getLongDescription, getName, getNextValidObject, getParent, getReportExtensionHelper, getResourceBundleName, getShortDescription, getVersion, isPrimaryAnalyzer, printEmbeddedReport, printEmbeddedReport, printEmbeddedReportWithOptions, printEmbeddedReportWithOptions, printReportInfoHeader, recordInternalExceptionStatic, setContext
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AllEnvVars

public AllEnvVars()
Null constructor for use as JavaBean

Method Detail

getInstance

public static AllEnvVars getInstance(IAnalyzerContext context,
                                     com.ibm.dtfj.image.ImageProcess parent)
Find the AllEnvVars bean instance associated with a given parent ImageProcess (create it if necessary)

Parameters:
context - the AnalyzerContext in which to locate this bean instance
parent - the parent ImageProcess underlying this analyzer bean
Returns:
the desired AllEnvVars analyzer bean

setParent

public void setParent(java.lang.Object parent)
Set the parent ImageProcess underlying this analyzer bean.

Specified by:
setParent in interface IWrapper
Overrides:
setParent in class SimpleAnalyzerBean
Parameters:
parent - The parent object to set. Must be of type ImageProcess. compatible with the type of analyzer bean that receives it
See Also:
IWrapper.setParent(java.lang.Object)

getEnvVar

public java.lang.String getEnvVar(java.lang.String key)
                           throws com.ibm.dtfj.image.DataUnavailable,
                                  com.ibm.dtfj.image.CorruptDataException
Get the value of an environment variable

Parameters:
key - the name of the environment variable desired
Returns:
the value of the desired environment variable
Throws:
com.ibm.dtfj.image.DataUnavailable
com.ibm.dtfj.image.CorruptDataException

produceReport

public IAnalysisReport produceReport()
Description copied from interface: IReport
Generate a report which will be encapsulated in the IAnalysisReport object for later use by some formatter.

Specified by:
produceReport in interface IReport
Overrides:
produceReport in class SimpleAnalyzerBean
Returns:
- the generic report object which will be given to some formatter
See Also:
IReport.produceReport()


© Copyright IBM Corp. 2007, 2008 All Rights Reserved. US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.