com.ibm.dtfj.analyzer.j2se.wrappers
Class PropertiesWrapper

java.lang.Object
  extended by TranslatableAnalyzer
      extended by com.ibm.dtfj.analyzer.base.SimpleAnalyzerBean
          extended by com.ibm.dtfj.analyzer.helpers.ValueWrapper
              extended by com.ibm.dtfj.analyzer.helpers.objectwrapper.ObjectWrapper
                  extended by com.ibm.dtfj.analyzer.helpers.base.MapWrapperBase
                      extended by com.ibm.dtfj.analyzer.j2se.wrappers.PropertiesWrapper
All Implemented Interfaces:
IAnalyzerBase, IReport, IWrapper, java.util.Map
Direct Known Subclasses:
PropertiesWrapper

public class PropertiesWrapper
extends MapWrapperBase

Extract information from a JavaObject that represents an instance of java.util.Properties


Nested Class Summary
 class PropertiesWrapper.Data
          An inner class used to represent the data contained in the original Properties.
 
Nested classes/interfaces inherited from interface java.util.Map
java.util.Map.Entry<K,V>
 
Field Summary
protected  com.ibm.dtfj.java.JavaObject theJavaObject
          The parent JavaObject underlying this analyzer bean
 
Fields inherited from class com.ibm.dtfj.analyzer.helpers.objectwrapper.ObjectWrapper
MODE_ALL, MODE_DEFAULT, MODE_INCLUDE_HEADER, MODE_INCLUDE_SIGNATURE, MODE_NONE, MODE_SHOW_INSTANCE_FINAL_FIELDS, MODE_SHOW_INSTANCE_NONFINAL_FIELDS, MODE_SHOW_STATIC_FINAL_FIELDS, MODE_SHOW_STATIC_NONFINAL_FIELDS, MODE_SPECIAL_FULL_REPORT
 
Constructor Summary
PropertiesWrapper()
           
 
Method Summary
 java.util.Set entrySet()
           
 PropertiesWrapper.Data getData()
          Return an object that represents the data contained in the original Properties object.
protected  java.lang.String getDataFieldName()
           
static PropertiesWrapper getInstance(IAnalyzerContext context, com.ibm.dtfj.java.JavaObject parent)
          Find the PropertiesWrapper bean instance associated with a given parent JavaObject (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 JavaObject underlying this analyzer bean.
 
Methods inherited from class com.ibm.dtfj.analyzer.helpers.base.MapWrapperBase
clear, containsKey, containsValue, get, isEmpty, keySet, put, putAll, remove, size, values
 
Methods inherited from class com.ibm.dtfj.analyzer.helpers.objectwrapper.ObjectWrapper
checkMaskedField, endPrintGroup, getCachingPriority, getInstance, getValueAtPath, getValueAtPath, getVersion, printCollectionEntriesAtPath, printCollectionEntriesAtPath, printCollectionMapEntryReportsAtPath, printCollectionSizeAtPath, printCollectionValueReportsAtPath, printReportAtPath, printValueAtPath, printValueAtPath, setMaskedFieldPattern, startPrintGroup, toString
 
Methods inherited from class com.ibm.dtfj.analyzer.helpers.ValueWrapper
equals, getBooleanValue, getByteValue, getCharacterValue, getDoubleValue, getFloatValue, getIntegerValue, getJavaClassValue, getJavaObjectValue, getLongValue, getObjectWrapper, getObjectWrapper, getOneJavaClassValue, getOneJavaObjectValue, getRawValue, getShortValue, getStringValue, getTypeSignature, getValueWrapperInstance, hashCode, isBoolean, isByte, isCharacter, isDouble, isFloat, isInstanceOf, isInteger, isJavaClass, isJavaObject, isLong, isShort, isString
 
Methods inherited from class com.ibm.dtfj.analyzer.base.SimpleAnalyzerBean
allocateReport, allocateReportOptions, allocateSecondaryReport, getCategories, getContext, getIdentityString, getInstance, getLogger, getLongDescription, getName, getNextValidObject, getParent, getReportExtensionHelper, getResourceBundleName, getShortDescription, isPrimaryAnalyzer, printEmbeddedReport, printEmbeddedReport, printEmbeddedReportWithOptions, printEmbeddedReportWithOptions, printReportInfoHeader, recordInternalExceptionStatic, setContext
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.Map
equals, hashCode
 

Field Detail

theJavaObject

protected com.ibm.dtfj.java.JavaObject theJavaObject
The parent JavaObject underlying this analyzer bean

Constructor Detail

PropertiesWrapper

public PropertiesWrapper()
Method Detail

getInstance

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

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

setParent

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

Specified by:
setParent in interface IWrapper
Overrides:
setParent in class ValueWrapper
Parameters:
parent - The parent object to set. Must be of type JavaObject, and this JavaObject must represent an instance of a java.util.Properties.
See Also:
IWrapper.setParent(java.lang.Object)

getDataFieldName

protected java.lang.String getDataFieldName()
Returns:
the name of the field that contains the properties data in a java.util.Properties. This is defined through a method to allow overriding in subclasses.

getData

public PropertiesWrapper.Data getData()
                               throws com.ibm.dtfj.image.DTFJException
Return an object that represents the data contained in the original Properties object. See PropertiesWrapper.Data.

Returns:
an object that represents the data contained in the original Properties object.
Throws:
com.ibm.dtfj.image.DTFJException

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 MapWrapperBase
Returns:
- the generic report object which will be given to some formatter
See Also:
IReport.produceReport()

entrySet

public java.util.Set entrySet()
Specified by:
entrySet in interface java.util.Map
Specified by:
entrySet in class MapWrapperBase
See Also:
Map.entrySet()


© 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.