Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

net.sf.xsnapshot.tagshandler
Class XSnapshotTagsHandler

java.lang.Object
  extended byxdoclet.template.TemplateTagHandler
      extended byxdoclet.XDocletTagSupport
          extended bynet.sf.xsnapshot.tagshandler.XSnapshotTagsHandler
public class XSnapshotTagsHandler
extends xdoclet.XDocletTagSupport

TagsHandler for all XSnapshot XDoclet template tags. * * @xdoclet.taghandler namespace="XSnapshot" * @author Daniel Kokotov, Bill Schneider

Field Summary
static String AGGRESSIVE_COPY_TO_MODEL_POLICY
          keyword for the aggressive copy to model policy
static String ALL_COPY_TO_MODEL_POLICY
          keyword for the all copy to model policy
static String ARRAY_TAG
          tag name for declaring an array snapshot property
static String COLLECTION_ELEMENT_NESTED_PARAM
          attribute for specifying a BeanUtils style prooperty reference to be * applied to elements of the collection in the model
static String COLLECTION_ELEMENT_SNAPSHOT_NAME_PARAM
          attribute for specifying the name of the snapshot on the elements in the * collection in the model that will produce the elements of the collection * in the snapshot
static String COLLECTION_TAG
          tag name for declaring a collection snapshot property
static String COMPARISON_ORDER_PARAM
          attribute for specifying the order in the generated compareTo method that * this property should take if the generate-equals for that snapshot is set * to 'enumerated'
static String CONSERVATIVE_COPY_TO_MODEL_POLICY
          keyword for the conservative copy to model policy
static String COPY_TO_MODEL_POLICY_PARAM
          attribute name for class-level copy-to-model policy
static String ENUMERATED_KEYWORD
          keyword for indicating that xsnapshot should generate an equals, * hashCode, compareTo, toString methods that use the Commons Lang builders * and include the properties specified by appropriate markers on the * property tags
static String EQUALS_GENERATE_PARAM
          attribute for specifying how the equals, hashCode, and compareTo methods * should be generated for this snapshot class
static String EXTENDS_PARAM
          attribute for specifying the classname of the superclass of the snapshot * class
static String GENERATE_HELPER_PARAM
          attribute name to control helper generation
static String HELPER_SUFFIX
          suffix used to construct helper classname from snapshot classname
static String IMPLEMENTS_PARAM
          attribute for specifying a list of interfaces implemented by the snapshot * class
static String INIT_VALUE_PARAM
          attribute for specifying an initial value for a property. the value of * this attribute is taken verbatim and used as the initializer for the * private member field backing the property
static String[] KEYWORD_COPY_TO_MODEL_POLICIES
           
static String MAP_KEY_NESTED_PARAM
          attribute for specifying a BeanUtils style property reference to the keys * of the map in the model
static String MAP_KEY_SNAPSHOT_NAME_PARAM
          attribute for specifying the key of the snapshot on the keys of the map * in the model
static String MAP_TAG
          tag name for declaring a map snapshot property
static String MAP_VALUE_NESTED_PARAM
          attribute for specifying a BeanUtils style property reference to the * values of the map in the model
static String MAP_VALUE_SNAPSHOT_NAME_PARAM
          attribute for specifying the name of the snapshot on the values of the map * in the model
static String MATCH_ALL
          * Wildcard used to indicate a property declaration should match all * * snapshots *
static String MATCH_PARAM
          attribute for specifying which snapshots this property declaration * applies to
static String MEMBER_VAR_PREFIX
          prefix used to construct member variable name from property name
static String MODEL_COLLECTION_ARRAY_CREATE_EXPR_PARAM
          attribute for specifying explicitly the expression to initialize the * value of the collection in the model
static String MODEL_COLLECTION_ELEMENT_NESTED_TYPE_PARAM
          attribute for specifying the types of the elements of the collection in * the model after applying nested property calculation.
static String MODEL_COLLECTION_ELEMENT_TRANSFORMER_ARG_PARAM_PREFIX
          attribute prefix for specifying args for a transformer to be applied to * elements of the * collection in the snapshot when transforming back to model
static String MODEL_COLLECTION_ELEMENT_TRANSFORMER_PARAM
          attribute for specifying a transformer to be applied to elements of the * collection in the snapshot when transforming back to model
static String MODEL_COLLECTION_ELEMENT_TYPE_PARAM
          attribute for specifying the types of the elements of the collection in * the model
static String MODEL_EXTENDS_PARAM
          attribute for specifying the class on which the snapshot with the key * specified by SNAPSHOT_EXTENDS_PARAM attribute is defined, used to calculate * the superclass of the snapshot class
static String MODEL_MAP_CREATE_EXPR_PARAM
          attribute for specifying the expression for initializing the value of the * map in the model
static String MODEL_MAP_KEY_NESTED_TYPE_PARAM
          attribute for specifying the types of the keys of the map in * the model after applying nested property calculation.
static String MODEL_MAP_KEY_TRANSFORMER_ARG_PARAM_PREFIX
          attribute prefix for specifying an arg for transformer to be applied to the keys of the map * in the snapshot
static String MODEL_MAP_KEY_TRANSFORMER_PARAM
          attribute for specifying a transformer to be applied to the keys of the map * in the snapshot
static String MODEL_MAP_KEY_TYPE_PARAM
          attribute for specifying the types of the keys of the map in * the model
static String MODEL_MAP_VALUE_NESTED_TYPE_PARAM
          attribute for specifying the types of the values of the map in * the model after applying nested property calculation.
static String MODEL_MAP_VALUE_TRANSFORMER_ARG_PARAM_PREFIX
          attribute prefix for specifying an arg for transformer to be applied to the values of the map * in the snapshot
static String MODEL_MAP_VALUE_TRANSFORMER_PARAM
          attribute for specifying a transformer to be applied to the values of the map * in the snapshot
static String MODEL_MAP_VALUE_TYPE_PARAM
          attribute for specifying the types of the values of the map in * the model
static String MODERATE_COPY_TO_MODEL_POLICY
          keyword for the moderate copy to model policy
static String NONE_COPY_TO_MODEL_POLICY
          keyword for the none copy to model policy
static String NONE_KEYWORD
          keyword for indicating no equals or tostring method should be generated * by xsnapshot, or that no getter or setter should be generated
static String PROPERTY_COPY_TO_MODEL_PARAM
          attribute for specifying explicitly whether this property will be copied by the auto * generated helper when transforming the snapshot back into the model
static String PROPERTY_GETTER_ACCESS_PARAM
          attribute for specifying the access modifier for the getter in the snapshot
static String PROPERTY_NAME_PARAM
          attribute fior specifying the name of the property in the snapshot
static String PROPERTY_SETTER_ACCESS_PARAM
          attribute for specifying the access modifier for the setter in the snapshot
static String PROPERTY_TAG
          tag name for declaring a regular snapshot property
static String PROPERTY_TYPE_PARAM
          attribute for specifying explicitly the type of the property in the * snapshot
static String REFLECTION_KEYWORD
          keyword for indicating that xsnapshot should generate an equals, * hashCode, compareTo, toString methods that use the Commons Lang * reflection methods
static String SIMPLE_PROPERTY_MODEL_TRANSFORMER_ARG_PARAM_PREFIX
          attribute prefix for specifying an arg to a transformer to apply to the value * returned by * the snapshot class's getter before setting it in the model
static String SIMPLE_PROPERTY_MODEL_TRANSFORMER_PARAM
          attribute for specifying a transformer to apply to the value returned by * the snapshot class's getter before setting it in the model
static String SIMPLE_PROPERTY_NESTED_PARAM
          attribute for specifying an expression which must be a BeanUtils-style * property expression to be applied to the return of the property to * calculate the actual property for the rest of the tag declaration
static String SIMPLE_PROPERTY_SNAPSHOT_NAME_PARAM
          attribute for specifying the key of the snapshot on the type of the * property in the model which will determine the type of the property in * the snapshot
static String SIMPLE_PROPERTY_SNAPSHOT_TRANSFORMER_ARG_PARAM_PREFIX
          attribute prefix for specifying an arg to a transformer to apply to the value * returned by * the model class's getter before setting it in the snapshot.
static String SIMPLE_PROPERTY_SNAPSHOT_TRANSFORMER_PARAM
          attribute for specifying a transformer to apply to the value returned by * the model class's getter before setting it in the snapshot
static String SNAPSHOT_CLASS_PARAM
          attribute for specifying the classname of the snapshot class explicitly
static String SNAPSHOT_CLASS_TAG
          tag name for the declaration of a snapshot on a model class
static String SNAPSHOT_COLLECTION_ARRAY_CREATE_EXPR_PARAM
          attribute for specifying explicitly the expression to initialize the * value of the collection in the snapshot
static String SNAPSHOT_COLLECTION_ELEMENT_TRANSFORMER_ARG_PARAM_PREFIX
          attribute for specifying a transformer to be applied to elements of the * collection in the model
static String SNAPSHOT_COLLECTION_ELEMENT_TRANSFORMER_PARAM
          attribute for specifying a transformer to be applied to elements of the * collection in the model
static String SNAPSHOT_COLLECTION_ELEMENT_TYPE_PARAM
          attribute for specifying explicitly the type of the elements in the * colleciton in the snapshot
static String SNAPSHOT_EXTENDS_PARAM
          attribute for specifying the key of the snapshot on the class specified * by MODEL_EXTENDS_PARAM attribute, used to calculate the superclass of the * snapshot class
static String SNAPSHOT_MAP_CREATE_EXPR_PARAM
          attribute for specifying the expression for initializing the value of the * map in the snapshot
static String SNAPSHOT_MAP_KEY_TRANSFORMER_ARG_PARAM_PREFIX
          attribute prefix for specifying an arg for transformer to be applied to the keys of the map * in the model
static String SNAPSHOT_MAP_KEY_TRANSFORMER_PARAM
          attribute for specifying a transformer to be applied to the keys of the map * in the model
static String SNAPSHOT_MAP_KEY_TYPE_PARAM
          attribute for specifying explitly the type of the keys of the map in the * snapshot
static String SNAPSHOT_MAP_VALUE_TRANSFORMER_ARG_PARAM_PREFIX
          attribute prefix for specifying an arg for transformer to be applied to the values of the map * in the model
static String SNAPSHOT_MAP_VALUE_TRANSFORMER_PARAM
          attribute for specifying a transformer to be applied to the values of the map * in the model
static String SNAPSHOT_MAP_VALUE_TYPE_PARAM
          attribute for specifying explitly the type of the values of the map in * the snapshot
static String SNAPSHOT_NAME_PARAM
          attribute for specifying the key used to refer to this snapshot
static String SNAPSHOT_SPECIFIC_MERGE_PATTERN
          merge pattern for the file to merge in per snapshot
static String SUPER_EXTENDS_KEYWORD
          syntatic sugar keyword for the model-extends attribute that is a synonym * for the superclass of the model class in which the snapshot is defined
static String THIS_EXTENDS_KEYWORD
          syntatic sugar keyword for the model-extends attribute that is a synonym * for the model class in which the snapshot is defined
static String TOSTRING_GENERATE_PARAM
          attribute for specifying how the toString method should be generated for * this snapshot class
static String TOSTRING_ORDER_PARAM
          attribute for specifying the order in the generated toString method that * this property should take if the generate-tostring for that snapshot is * set to 'enumerated'
static String USE_IN_EQUALS_PARAM
          attribute for specifying whether this property should be included in * calculating equals, hashCode, and compareTo for this snapshot if the * generate-equals attribute for that snapshot is set to 'enumerated'
static String USE_IN_TOSTRING_PARAM
          attribute for specifying whether this property should be included in * calculating toString for this snapshot if the generate-tostring attribute * for that snapshot is set to 'enumerated'
static String XSNAPSHOT_TAG_PREFIX
           
 
Fields inherited from class xdoclet.XDocletTagSupport
FOR_CLASS, FOR_CONSTRUCTOR, FOR_FIELD, FOR_METHOD, PARAMETER_DELIMITER
 
Constructor Summary
XSnapshotTagsHandler()
           
 
Method Summary
 String collectionArrayElementNestedProperty()
           
 String collectionArrayElementSnapshotName()
           
 void conversionMethodForType(String template)
           
 void defaultConcreteCollectionType(String template)
          output the default concrete collection class for the collection class * generated by the contained template * @param template * @return * @throws XDocletException
 void defaultConcreteMapType(String template)
          output the default concerte map class for the map class generated by the * contained template * @param template * @throws XDocletException
 void defaultValueForType(String template)
           
 String extendsFrom()
          Returns the class this extends from
 void forAllComparableProperties(String template)
          Runs the contained template for all properties that are to be used in the * compareTo method generation for the current snapshot
 void forAllEqualsProperties(String template)
          Runs the contained template for all properties that are to be used in the * equals method generation for the current snapshot
 void forAllHashCodeProperties(String template)
          Runs the contained template for all properties that are to be used in the * hashCode method generation for the current snapshot
 void forAllToStringProperties(String template)
           
 void forAllXSnapshotProperties(String template)
          * runs the specified template for all properties that should be included in * * the current snapshot *
protected  xjavadoc.XMethod getNestedProperty()
          returns the nested property for simple property tags, ie the property * corresponding to the final segment in a nested property reference.
static String getSnapshotClass(xjavadoc.XClass clazz, String snapshotName)
          retrieve the qualified class name for the given snapshot on given class * @param clazz * the model class on which the snapshot is defined * @param snapshotName * the key of the snapshot whose class name is desired * @return the qualified class naame of the snapshot, or null if no snapshot * with that name on that class
static String getSnapshotClass(xjavadoc.XTag tag)
          get the qualified class name of the snapshot defined by the given * xsnapshot.snapshot-class tag.
static String getSnapshotName(xjavadoc.XTag tag)
          get the name of the snapshot defined by the give xsnapshot.snapshot-class tag * @param tag the tag that defines the snapshot. name of tag must be xsnapshot.snapshot-class * @return the name of the snapshot
 String helperClass()
          get the class name of the helper class for the current snapshot * @doc.tag type="content"
 void ifCanUseDirectModelGetter(String template)
          runs the contained template if the current * property's model value can be obtained by direct call to the getter.
 void ifCanUseDirectModelSetter(String template)
          runs the contained template if the current * property's model value can be set by direct call to the setter.
 void ifCanUseDirectSnapshotGetter(String template)
          runs the contained template if the current * property's snapshot value can be obtained by direct call to the getter.
 void ifCanUseDirectSnapshotSetter(String template)
          runs the contained template if the current * property's snapshot value can be set by direct call to the setter.
 void ifCollectionArrayElementUsesNestedProperty(String template)
          Runs the contained template if the current collection/array tag specifies * a element-expr
 void ifCollectionArrayElementUsesSnapshot(String template)
          * Runs the contained template if the current collection tag specifies that * * its elements are snapshots *
 void ifCollectionArrayElementUsesTypeConversion(String template)
          Runs the contained template if this current collection/array tag requires * element type conversion
 void ifCurrentTagIsArray(String template)
           
 void ifCurrentTagIsArrayOrCollection(String template, Properties attrs)
           
 void ifCurrentTagIsCollection(String template, Properties attrs)
           
 void ifCurrentTagIsMap(String template, Properties attrs)
           
 void ifCurrentTagIsSimpleProperty(String template)
           
 void ifExtendsFromSnapshot(String template)
          runs the contained template if this snapshot extends from another * snapshot
 void ifGenerateEquals(String template)
          * Runs the contained template if we are generating the equals method, i.e
 void ifGenerateHelper(String template)
          Evaluate the template if we are generating the current helper
 void ifGenerateToString(String template)
          Runs the contained template if we are auto-generating the toString method * for this snapshot class
 void ifHasInitValue(String template)
          TODO: figure out correct behavior for collections, maps * runs the contained template if the current * xsnapshot.
 void ifHasSnapshotGetter(String template)
          runs the contained template if the current * property should have a getter in the snapshot * * @throws XDocletException *
 void ifHasSnapshotSetter(String template)
          runs the contained template if the current * property should have a setter in the snapshot * * @throws XDocletException *
 void ifImplementsComparable(String template)
          runs the contained template if the current snapshot is declared to * implement the Comparable interface
 void ifMapKeyUsesNestedProperty(String template)
          * Runs the contained template if the current map tag specifies a key-expr *
 void ifMapKeyUsesSnapshot(String template)
          * Runs the contained template if this current field is a mapKeyIsSnapshot
 void ifMapKeyUsesTypeConversion(String template)
          * Runs the contained template if this current map tag requires key type * * conversion *
 void ifMapValueUsesNestedProperty(String template)
          * Runs the contained template if the current map tag specifies a value-expr *
 void ifMapValueUsesSnapshot(String template)
          * Runs the contained template if this current field is a * * mapValueIsSnapshot
 void ifMapValueUsesTypeConversion(String template)
          * Runs the contained template if this current map tag requires value type * * conversion *
 void ifMatchesSnapshot(String template)
          runs the contained template if the current * xsnapshot.
 void ifModelCollectionArrayExplicitCreateExpr(String template)
          Runs the contained template if the current map tag specifies * an explicit create expr for the value of the map in the model
 void ifModelMapExplicitCreateExpr(String template)
          Runs the contained template if the current map tag specifies * an explicit create expr for the value of the map in the model
 void ifModelPropertyIsArray(String template)
          runs the contained template if the current property in the model is array-valued * @param template * @throws XDocletException
 void ifNotCanUseDirectModelGetter(String template)
          runs the contained template if the current * property's model value cannot be obtained by direct call to the getter
 void ifNotCanUseDirectModelSetter(String template)
          runs the contained template if the current * property's model value cannot be set by direct call to the setter
 void ifNotCanUseDirectSnapshotGetter(String template)
          runs the contained template if the current * property's snapshot value cannot be obtained by direct call to the getter
 void ifNotCanUseDirectSnapshotSetter(String template)
          runs the contained template if the current * property's snapshot value cannot be set by direct call to the setter
 void ifNotCollectionArrayElementUsesNestedProperty(String template)
          Runs the contained template if the current collection/array tag specifies * a element-expr
 void ifNotCollectionArrayElementUsesSnapshot(String template)
          * Runs the contained template if the current collection tag specifies that * * its elements are not snapshots *
 void ifNotCollectionArrayElementUsesTypeConversion(String template)
          * Runs the contained template if this current collection/array tag does not * * require element type conversion *
 void ifNotExtendsFromObject(String template)
          runs the contained template if this snapshot extends from a class * other than java.lang.Object.
 void ifNotMapKeyUsesNestedProperty(String template)
          * Runs the contained template if the current map tag does not specify a * * key-expr *
 void ifNotMapKeyUsesSnapshot(String template)
          * Runs the contained template if this current field is not a * * mapKeyIsSnapshot
 void ifNotMapKeyUsesTypeConversion(String template)
          * Runs the contained template if this current map tag does not require key * * type conversion *
 void ifNotMapValueUsesNestedProperty(String template)
          * Runs the contained template if the current map tag does not specify a * * value-expr *
 void ifNotMapValueUsesSnapshot(String template)
          * Runs the contained template if this current field is not a * * mapValueIsSnapshot
 void ifNotMapValueUsesTypeConversion(String template)
          * Runs the contained template if this current map tag does not require * * value type conversion *
 void ifNotModelCollectionArrayExplicitCreateExpr(String template)
          Runs the contained template if the current map tag does not specify * an explicit create expr for the value of the map in the model
 void ifNotModelMapExplicitCreateExpr(String template)
          Runs the contained template if the current map tag does not specify * an explicit create expr for the value of the map in the model
 void ifNotModelPropertyIsArray(String template)
          runs the contained template if the current property in the model is array-valued * @param template * @throws XDocletException
 void ifNotShouldCopySnapshotToModel(String template)
          runs the contained template if this property should NOT be copied over * when copying snapshot to model.
 void ifNotSimplePropertyUsesNestedProperty(String template)
          Runs the contained template if the current collection/array tag specifies * a element-expr
 void ifNotSimplePropertyUsesSnapshot(String template)
          Runs the contained template if this current field is not a * propertyReturnsSnapshot.
 void ifNotSimplePropertyUsesTypeConversion(String template)
          Runs the contained template if this current field does not require type * covnersion
 void ifNotSnapshotCollectionArrayExplicitCreateExpr(String template)
          Runs the contained template if the current map tag does not specify * an explicit create expr for the value of the map in the snapshot
 void ifNotSnapshotMapExplicitCreateExpr(String template)
          Runs the contained template if the current map tag does not specify * an explicit create expr for the value of the map in the snapshot
 void ifNotUseReflectionEquals(String template)
          Runs the contained template if we are not using reflection equals/hash * code strategy for this class
 void ifNotUseReflectionToString(String template)
          Runs the contained template if we are using reflection equals/hash code * strategy for this class
 void ifShouldCopySnapshotToModel(String template)
          runs the contained template if this property should be copied over * when copying snapshot to model.
 void ifSimplePropertyUsesNestedProperty(String template)
          Runs the contained template if the current collection/array tag specifies * a element-expr
 void ifSimplePropertyUsesSnapshot(String template)
          Runs the contained template if this current field is a * propertyReturnsSnapshot.
 void ifSimplePropertyUsesTypeConversion(String template)
          Runs the contained template if this current property tag requires type * conversion
 void ifSnapshotCollectionArrayExplicitCreateExpr(String template)
          Runs the contained template if the current map tag specifies * an explicit create expr for the value of the map in the snapshot
 void ifSnapshotMapExplicitCreateExpr(String template)
          Runs the contained template if the current map tag specifies * an explicit create expr for the value of the map in the snapshot
 void ifUseReflectionEquals(String template)
          Runs the contained template if we are using reflection equals/hash code * strategy for this class
 void ifUseReflectionToString(String template)
          Runs the contained template if we are using reflection equals/hash code * strategy for this class
 String initValue()
           
static boolean isPrimitive(String className)
           
static boolean isPrimitive(xjavadoc.XClass klass)
           
 String mapKeyNestedProperty()
           
 String mapKeySnapshotName()
           
 String mapValueNestedProperty()
           
 String mapValueSnapshotName()
           
 void mergeForSnapshot(String template)
           
 String modelCollectionArrayElementNestedType()
           
 String modelCollectionArrayElementTransformer()
           
 String modelCollectionArrayElementTransformerArgs()
           
 String modelCollectionArrayElementType()
           
 String modelCollectionArrayExplicitCreateExpr()
           
 String modelExtendsFrom()
          returns the model class on which the snapshot from which this snapshot is * defined. extends (assumes this extends from a snapshot) * * @doc.tag type="content" *
 String modelGetter()
          Return the string that should be used to get the value of the model * property.
 String modelMapExplicitCreateExpr()
           
 String modelMapKeyNestedType()
           
 String modelMapKeyTransformer()
           
 String modelMapKeyTransformerArgs()
           
 String modelMapKeyType()
           
 String modelMapValueNestedType()
           
 String modelMapValueTransformer()
           
 String modelMapValueTransformerArgs()
           
 String modelMapValueType()
           
 String modelPropertyName()
           
 String modelPropertyType()
           
 String modelSetter()
           
 String modelSimplePropertyNestedType()
           
 String modelSimplePropertyTransformer()
           
 String modelSimplePropertyTransformerArgs()
           
 String simplePropertyNestedProperty()
           
 String simplePropertySnapshotName()
           
 String snapshotArrayElementType()
           
 String snapshotClass()
          get the class name of the current snapshot * @doc.tag type="content"
 String snapshotCollectionArrayElementTargetType()
           
 String snapshotCollectionArrayElementTransformer()
           
 String snapshotCollectionArrayElementTransformerArgs()
           
 String snapshotCollectionArrayExplicitCreateExpr()
           
 String snapshotExtendsFrom()
          returns the name of the snapshot this snapshot is extending, if it is * extending a snapshot class, null otherwise * @doc.tag type="content"
 String snapshotGetter()
           
 String snapshotGetterAccess()
           
 String snapshotMapExplicitCreateExpr()
           
 String snapshotMapKeyTargetType()
           
 String snapshotMapKeyTransformer()
           
 String snapshotMapKeyTransformerArgs()
           
 String snapshotMapValueTargetType()
           
 String snapshotMapValueTransformer()
           
 String snapshotMapValueTransformerArgs()
           
 String snapshotName()
          get the key of the current snapshot * @doc.tag type="content"
 String snapshotPropertyName()
           
 String snapshotPropertySuffix()
          a suffix for variables based on the current property in the snapshot. basically * just snapshotPropertyName() with the first letter capitalized * @return * @throws XDocletException
 String snapshotPropertyType()
           
 String snapshotPropertyVar()
           
 String snapshotSetter()
           
 String snapshotSetterAccess()
           
 String snapshotSimplePropertyTargetType()
           
 String snapshotSimplePropertyTransformer()
           
 String snapshotSimplePropertyTransformerArgs()
           
 
Methods inherited from class xdoclet.XDocletTagSupport
delimit, expandClassName, generate, getCurrentClass, getCurrentClassTag, getCurrentConstructor, getCurrentField, getCurrentFieldTag, getCurrentMethod, getCurrentMethodTag, getCurrentPackage, getDocletContext, getEngine, getExpandedDelimitedTagValue, getTagValue, getTagValue, getTagValue, hasHavingClassTag, hasTag, isTagValueEqual, mandatoryParamNotFound, mandatoryTemplateTagParamNotFound, modifiers, popCurrentClass, pushCurrentClass, setCurrentClass, setCurrentClassTag, setCurrentConstructor, setCurrentField, setCurrentFieldTag, setCurrentMethod, setCurrentMethodTag, setCurrentPackage
 
Methods inherited from class xdoclet.template.TemplateTagHandler
getXJavaDoc, setXJavaDoc
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

XSNAPSHOT_TAG_PREFIX

public static final String XSNAPSHOT_TAG_PREFIX
See Also:
Constant Field Values

MATCH_ALL

public static final String MATCH_ALL
* Wildcard used to indicate a property declaration should match all * * snapshots *

See Also:
Constant Field Values

HELPER_SUFFIX

public static final String HELPER_SUFFIX
suffix used to construct helper classname from snapshot classname

See Also:
Constant Field Values

MEMBER_VAR_PREFIX

public static final String MEMBER_VAR_PREFIX
prefix used to construct member variable name from property name

See Also:
Constant Field Values

SNAPSHOT_CLASS_TAG

public static final String SNAPSHOT_CLASS_TAG
tag name for the declaration of a snapshot on a model class

See Also:
Constant Field Values

PROPERTY_TAG

public static final String PROPERTY_TAG
tag name for declaring a regular snapshot property

See Also:
Constant Field Values

COLLECTION_TAG

public static final String COLLECTION_TAG
tag name for declaring a collection snapshot property

See Also:
Constant Field Values

ARRAY_TAG

public static final String ARRAY_TAG
tag name for declaring an array snapshot property

See Also:
Constant Field Values

MAP_TAG

public static final String MAP_TAG
tag name for declaring a map snapshot property

See Also:
Constant Field Values

SNAPSHOT_CLASS_PARAM

public static final String SNAPSHOT_CLASS_PARAM
attribute for specifying the classname of the snapshot class explicitly

See Also:
Constant Field Values

SNAPSHOT_NAME_PARAM

public static final String SNAPSHOT_NAME_PARAM
attribute for specifying the key used to refer to this snapshot

See Also:
Constant Field Values

EXTENDS_PARAM

public static final String EXTENDS_PARAM
attribute for specifying the classname of the superclass of the snapshot * class

See Also:
Constant Field Values

SNAPSHOT_EXTENDS_PARAM

public static final String SNAPSHOT_EXTENDS_PARAM
attribute for specifying the key of the snapshot on the class specified * by MODEL_EXTENDS_PARAM attribute, used to calculate the superclass of the * snapshot class

See Also:
Constant Field Values

MODEL_EXTENDS_PARAM

public static final String MODEL_EXTENDS_PARAM
attribute for specifying the class on which the snapshot with the key * specified by SNAPSHOT_EXTENDS_PARAM attribute is defined, used to calculate * the superclass of the snapshot class

See Also:
Constant Field Values

IMPLEMENTS_PARAM

public static final String IMPLEMENTS_PARAM
attribute for specifying a list of interfaces implemented by the snapshot * class

See Also:
Constant Field Values

EQUALS_GENERATE_PARAM

public static final String EQUALS_GENERATE_PARAM
attribute for specifying how the equals, hashCode, and compareTo methods * should be generated for this snapshot class

See Also:
Constant Field Values

TOSTRING_GENERATE_PARAM

public static final String TOSTRING_GENERATE_PARAM
attribute for specifying how the toString method should be generated for * this snapshot class

See Also:
Constant Field Values

GENERATE_HELPER_PARAM

public static final String GENERATE_HELPER_PARAM
attribute name to control helper generation

See Also:
Constant Field Values

COPY_TO_MODEL_POLICY_PARAM

public static final String COPY_TO_MODEL_POLICY_PARAM
attribute name for class-level copy-to-model policy

See Also:
Constant Field Values

PROPERTY_NAME_PARAM

public static final String PROPERTY_NAME_PARAM
attribute fior specifying the name of the property in the snapshot

See Also:
Constant Field Values

MATCH_PARAM

public static final String MATCH_PARAM
attribute for specifying which snapshots this property declaration * applies to

See Also:
Constant Field Values

USE_IN_EQUALS_PARAM

public static final String USE_IN_EQUALS_PARAM
attribute for specifying whether this property should be included in * calculating equals, hashCode, and compareTo for this snapshot if the * generate-equals attribute for that snapshot is set to 'enumerated'

See Also:
Constant Field Values

USE_IN_TOSTRING_PARAM

public static final String USE_IN_TOSTRING_PARAM
attribute for specifying whether this property should be included in * calculating toString for this snapshot if the generate-tostring attribute * for that snapshot is set to 'enumerated'

See Also:
Constant Field Values

COMPARISON_ORDER_PARAM

public static final String COMPARISON_ORDER_PARAM
attribute for specifying the order in the generated compareTo method that * this property should take if the generate-equals for that snapshot is set * to 'enumerated'

See Also:
Constant Field Values

TOSTRING_ORDER_PARAM

public static final String TOSTRING_ORDER_PARAM
attribute for specifying the order in the generated toString method that * this property should take if the generate-tostring for that snapshot is * set to 'enumerated'

See Also:
Constant Field Values

INIT_VALUE_PARAM

public static final String INIT_VALUE_PARAM
attribute for specifying an initial value for a property. the value of * this attribute is taken verbatim and used as the initializer for the * private member field backing the property

See Also:
Constant Field Values

PROPERTY_TYPE_PARAM

public static final String PROPERTY_TYPE_PARAM
attribute for specifying explicitly the type of the property in the * snapshot

See Also:
Constant Field Values

PROPERTY_COPY_TO_MODEL_PARAM

public static final String PROPERTY_COPY_TO_MODEL_PARAM
attribute for specifying explicitly whether this property will be copied by the auto * generated helper when transforming the snapshot back into the model

See Also:
Constant Field Values

PROPERTY_GETTER_ACCESS_PARAM

public static final String PROPERTY_GETTER_ACCESS_PARAM
attribute for specifying the access modifier for the getter in the snapshot. * You can use the value of "none" to specify no getter at all. * the default is public.

See Also:
Constant Field Values

PROPERTY_SETTER_ACCESS_PARAM

public static final String PROPERTY_SETTER_ACCESS_PARAM
attribute for specifying the access modifier for the setter in the snapshot. * You can use the value of "none" to specify no setter at all. * the default is public.

See Also:
Constant Field Values

SIMPLE_PROPERTY_NESTED_PARAM

public static final String SIMPLE_PROPERTY_NESTED_PARAM
attribute for specifying an expression which must be a BeanUtils-style * property expression to be applied to the return of the property to * calculate the actual property for the rest of the tag declaration

See Also:
Constant Field Values

SIMPLE_PROPERTY_SNAPSHOT_TRANSFORMER_PARAM

public static final String SIMPLE_PROPERTY_SNAPSHOT_TRANSFORMER_PARAM
attribute for specifying a transformer to apply to the value returned by * the model class's getter before setting it in the snapshot

See Also:
Constant Field Values

SIMPLE_PROPERTY_SNAPSHOT_TRANSFORMER_ARG_PARAM_PREFIX

public static final String SIMPLE_PROPERTY_SNAPSHOT_TRANSFORMER_ARG_PARAM_PREFIX
attribute prefix for specifying an arg to a transformer to apply to the value * returned by * the model class's getter before setting it in the snapshot.

See Also:
Constant Field Values

SIMPLE_PROPERTY_MODEL_TRANSFORMER_PARAM

public static final String SIMPLE_PROPERTY_MODEL_TRANSFORMER_PARAM
attribute for specifying a transformer to apply to the value returned by * the snapshot class's getter before setting it in the model

See Also:
Constant Field Values

SIMPLE_PROPERTY_MODEL_TRANSFORMER_ARG_PARAM_PREFIX

public static final String SIMPLE_PROPERTY_MODEL_TRANSFORMER_ARG_PARAM_PREFIX
attribute prefix for specifying an arg to a transformer to apply to the value * returned by * the snapshot class's getter before setting it in the model

See Also:
Constant Field Values

SIMPLE_PROPERTY_SNAPSHOT_NAME_PARAM

public static final String SIMPLE_PROPERTY_SNAPSHOT_NAME_PARAM
attribute for specifying the key of the snapshot on the type of the * property in the model which will determine the type of the property in * the snapshot

See Also:
Constant Field Values

SNAPSHOT_COLLECTION_ARRAY_CREATE_EXPR_PARAM

public static final String SNAPSHOT_COLLECTION_ARRAY_CREATE_EXPR_PARAM
attribute for specifying explicitly the expression to initialize the * value of the collection in the snapshot

See Also:
Constant Field Values

SNAPSHOT_COLLECTION_ELEMENT_TYPE_PARAM

public static final String SNAPSHOT_COLLECTION_ELEMENT_TYPE_PARAM
attribute for specifying explicitly the type of the elements in the * colleciton in the snapshot

See Also:
Constant Field Values

COLLECTION_ELEMENT_SNAPSHOT_NAME_PARAM

public static final String COLLECTION_ELEMENT_SNAPSHOT_NAME_PARAM
attribute for specifying the name of the snapshot on the elements in the * collection in the model that will produce the elements of the collection * in the snapshot

See Also:
Constant Field Values

COLLECTION_ELEMENT_NESTED_PARAM

public static final String COLLECTION_ELEMENT_NESTED_PARAM
attribute for specifying a BeanUtils style prooperty reference to be * applied to elements of the collection in the model

See Also:
Constant Field Values

SNAPSHOT_COLLECTION_ELEMENT_TRANSFORMER_PARAM

public static final String SNAPSHOT_COLLECTION_ELEMENT_TRANSFORMER_PARAM
attribute for specifying a transformer to be applied to elements of the * collection in the model

See Also:
Constant Field Values

SNAPSHOT_COLLECTION_ELEMENT_TRANSFORMER_ARG_PARAM_PREFIX

public static final String SNAPSHOT_COLLECTION_ELEMENT_TRANSFORMER_ARG_PARAM_PREFIX
attribute for specifying a transformer to be applied to elements of the * collection in the model

See Also:
Constant Field Values

MODEL_COLLECTION_ELEMENT_TYPE_PARAM

public static final String MODEL_COLLECTION_ELEMENT_TYPE_PARAM
attribute for specifying the types of the elements of the collection in * the model

See Also:
Constant Field Values

MODEL_COLLECTION_ELEMENT_NESTED_TYPE_PARAM

public static final String MODEL_COLLECTION_ELEMENT_NESTED_TYPE_PARAM
attribute for specifying the types of the elements of the collection in * the model after applying nested property calculation.

See Also:
Constant Field Values

MODEL_COLLECTION_ARRAY_CREATE_EXPR_PARAM

public static final String MODEL_COLLECTION_ARRAY_CREATE_EXPR_PARAM
attribute for specifying explicitly the expression to initialize the * value of the collection in the model

See Also:
Constant Field Values

MODEL_COLLECTION_ELEMENT_TRANSFORMER_PARAM

public static final String MODEL_COLLECTION_ELEMENT_TRANSFORMER_PARAM
attribute for specifying a transformer to be applied to elements of the * collection in the snapshot when transforming back to model

See Also:
Constant Field Values

MODEL_COLLECTION_ELEMENT_TRANSFORMER_ARG_PARAM_PREFIX

public static final String MODEL_COLLECTION_ELEMENT_TRANSFORMER_ARG_PARAM_PREFIX
attribute prefix for specifying args for a transformer to be applied to * elements of the * collection in the snapshot when transforming back to model

See Also:
Constant Field Values

SNAPSHOT_MAP_CREATE_EXPR_PARAM

public static final String SNAPSHOT_MAP_CREATE_EXPR_PARAM
attribute for specifying the expression for initializing the value of the * map in the snapshot

See Also:
Constant Field Values

MODEL_MAP_CREATE_EXPR_PARAM

public static final String MODEL_MAP_CREATE_EXPR_PARAM
attribute for specifying the expression for initializing the value of the * map in the model

See Also:
Constant Field Values

MAP_KEY_SNAPSHOT_NAME_PARAM

public static final String MAP_KEY_SNAPSHOT_NAME_PARAM
attribute for specifying the key of the snapshot on the keys of the map * in the model

See Also:
Constant Field Values

SNAPSHOT_MAP_KEY_TYPE_PARAM

public static final String SNAPSHOT_MAP_KEY_TYPE_PARAM
attribute for specifying explitly the type of the keys of the map in the * snapshot

See Also:
Constant Field Values

MODEL_MAP_KEY_TYPE_PARAM

public static final String MODEL_MAP_KEY_TYPE_PARAM
attribute for specifying the types of the keys of the map in * the model

See Also:
Constant Field Values

MODEL_MAP_KEY_NESTED_TYPE_PARAM

public static final String MODEL_MAP_KEY_NESTED_TYPE_PARAM
attribute for specifying the types of the keys of the map in * the model after applying nested property calculation.

See Also:
Constant Field Values

MAP_KEY_NESTED_PARAM

public static final String MAP_KEY_NESTED_PARAM
attribute for specifying a BeanUtils style property reference to the keys * of the map in the model

See Also:
Constant Field Values

SNAPSHOT_MAP_KEY_TRANSFORMER_PARAM

public static final String SNAPSHOT_MAP_KEY_TRANSFORMER_PARAM
attribute for specifying a transformer to be applied to the keys of the map * in the model

See Also:
Constant Field Values

SNAPSHOT_MAP_KEY_TRANSFORMER_ARG_PARAM_PREFIX

public static final String SNAPSHOT_MAP_KEY_TRANSFORMER_ARG_PARAM_PREFIX
attribute prefix for specifying an arg for transformer to be applied to the keys of the map * in the model

See Also:
Constant Field Values

MODEL_MAP_KEY_TRANSFORMER_PARAM

public static final String MODEL_MAP_KEY_TRANSFORMER_PARAM
attribute for specifying a transformer to be applied to the keys of the map * in the snapshot

See Also:
Constant Field Values

MODEL_MAP_KEY_TRANSFORMER_ARG_PARAM_PREFIX

public static final String MODEL_MAP_KEY_TRANSFORMER_ARG_PARAM_PREFIX
attribute prefix for specifying an arg for transformer to be applied to the keys of the map * in the snapshot

See Also:
Constant Field Values

SNAPSHOT_MAP_VALUE_TYPE_PARAM

public static final String SNAPSHOT_MAP_VALUE_TYPE_PARAM
attribute for specifying explitly the type of the values of the map in * the snapshot

See Also:
Constant Field Values

MODEL_MAP_VALUE_TYPE_PARAM

public static final String MODEL_MAP_VALUE_TYPE_PARAM
attribute for specifying the types of the values of the map in * the model

See Also:
Constant Field Values

MODEL_MAP_VALUE_NESTED_TYPE_PARAM

public static final String MODEL_MAP_VALUE_NESTED_TYPE_PARAM
attribute for specifying the types of the values of the map in * the model after applying nested property calculation.

See Also:
Constant Field Values

MAP_VALUE_SNAPSHOT_NAME_PARAM

public static final String MAP_VALUE_SNAPSHOT_NAME_PARAM
attribute for specifying the name of the snapshot on the values of the map * in the model

See Also:
Constant Field Values

MAP_VALUE_NESTED_PARAM

public static final String MAP_VALUE_NESTED_PARAM
attribute for specifying a BeanUtils style property reference to the * values of the map in the model

See Also:
Constant Field Values

SNAPSHOT_MAP_VALUE_TRANSFORMER_PARAM

public static final String SNAPSHOT_MAP_VALUE_TRANSFORMER_PARAM
attribute for specifying a transformer to be applied to the values of the map * in the model

See Also:
Constant Field Values

SNAPSHOT_MAP_VALUE_TRANSFORMER_ARG_PARAM_PREFIX

public static final String SNAPSHOT_MAP_VALUE_TRANSFORMER_ARG_PARAM_PREFIX
attribute prefix for specifying an arg for transformer to be applied to the values of the map * in the model

See Also:
Constant Field Values

MODEL_MAP_VALUE_TRANSFORMER_PARAM

public static final String MODEL_MAP_VALUE_TRANSFORMER_PARAM
attribute for specifying a transformer to be applied to the values of the map * in the snapshot

See Also:
Constant Field Values

MODEL_MAP_VALUE_TRANSFORMER_ARG_PARAM_PREFIX

public static final String MODEL_MAP_VALUE_TRANSFORMER_ARG_PARAM_PREFIX
attribute prefix for specifying an arg for transformer to be applied to the values of the map * in the snapshot

See Also:
Constant Field Values

THIS_EXTENDS_KEYWORD

public static final String THIS_EXTENDS_KEYWORD
syntatic sugar keyword for the model-extends attribute that is a synonym * for the model class in which the snapshot is defined

See Also:
Constant Field Values

SUPER_EXTENDS_KEYWORD

public static final String SUPER_EXTENDS_KEYWORD
syntatic sugar keyword for the model-extends attribute that is a synonym * for the superclass of the model class in which the snapshot is defined

See Also:
Constant Field Values

NONE_KEYWORD

public static final String NONE_KEYWORD
keyword for indicating no equals or tostring method should be generated * by xsnapshot, or that no getter or setter should be generated

See Also:
Constant Field Values

REFLECTION_KEYWORD

public static final String REFLECTION_KEYWORD
keyword for indicating that xsnapshot should generate an equals, * hashCode, compareTo, toString methods that use the Commons Lang * reflection methods

See Also:
Constant Field Values

ENUMERATED_KEYWORD

public static final String ENUMERATED_KEYWORD
keyword for indicating that xsnapshot should generate an equals, * hashCode, compareTo, toString methods that use the Commons Lang builders * and include the properties specified by appropriate markers on the * property tags

See Also:
Constant Field Values

NONE_COPY_TO_MODEL_POLICY

public static final String NONE_COPY_TO_MODEL_POLICY
keyword for the none copy to model policy

See Also:
Constant Field Values

CONSERVATIVE_COPY_TO_MODEL_POLICY

public static final String CONSERVATIVE_COPY_TO_MODEL_POLICY
keyword for the conservative copy to model policy

See Also:
Constant Field Values

MODERATE_COPY_TO_MODEL_POLICY

public static final String MODERATE_COPY_TO_MODEL_POLICY
keyword for the moderate copy to model policy

See Also:
Constant Field Values

AGGRESSIVE_COPY_TO_MODEL_POLICY

public static final String AGGRESSIVE_COPY_TO_MODEL_POLICY
keyword for the aggressive copy to model policy

See Also:
Constant Field Values

ALL_COPY_TO_MODEL_POLICY

public static final String ALL_COPY_TO_MODEL_POLICY
keyword for the all copy to model policy

See Also:
Constant Field Values

KEYWORD_COPY_TO_MODEL_POLICIES

public static final String[] KEYWORD_COPY_TO_MODEL_POLICIES

SNAPSHOT_SPECIFIC_MERGE_PATTERN

public static final String SNAPSHOT_SPECIFIC_MERGE_PATTERN
merge pattern for the file to merge in per snapshot

See Also:
Constant Field Values
Constructor Detail

XSnapshotTagsHandler

public XSnapshotTagsHandler()
Method Detail

getNestedProperty

protected xjavadoc.XMethod getNestedProperty()
                                      throws xdoclet.XDocletException
returns the nested property for simple property tags, ie the property * corresponding to the final segment in a nested property reference. If * the current property is not a simple property, or has no nested property * reference, return null.

Throws:
xdoclet.XDocletException

isPrimitive

public static boolean isPrimitive(String className)

isPrimitive

public static boolean isPrimitive(xjavadoc.XClass klass)

getSnapshotClass

public static String getSnapshotClass(xjavadoc.XClass clazz,
                                      String snapshotName)
retrieve the qualified class name for the given snapshot on given class * @param clazz * the model class on which the snapshot is defined * @param snapshotName * the key of the snapshot whose class name is desired * @return the qualified class naame of the snapshot, or null if no snapshot * with that name on that class

getSnapshotClass

public static String getSnapshotClass(xjavadoc.XTag tag)
get the qualified class name of the snapshot defined by the given * xsnapshot.snapshot-class tag. If classname is explicitly specified, * use that, otherwise use the configured pattern to auto-generate the classname. * * @param tag the tag that defines the snapshot. name of tag must be xsnapshot.snapshot-class * @return the class name of the snapshot

getSnapshotName

public static String getSnapshotName(xjavadoc.XTag tag)
get the name of the snapshot defined by the give xsnapshot.snapshot-class tag * @param tag the tag that defines the snapshot. name of tag must be xsnapshot.snapshot-class * @return the name of the snapshot

snapshotClass

public String snapshotClass()
                     throws xdoclet.XDocletException
get the class name of the current snapshot * @doc.tag type="content"

Throws:
xdoclet.XDocletException

helperClass

public String helperClass()
                   throws xdoclet.XDocletException
get the class name of the helper class for the current snapshot * @doc.tag type="content"

Throws:
xdoclet.XDocletException

snapshotName

public String snapshotName()
                    throws xdoclet.XDocletException
get the key of the current snapshot * @doc.tag type="content"

Throws:
xdoclet.XDocletException

extendsFrom

public String extendsFrom()
                   throws xdoclet.XDocletException
Returns the class this extends from. * if the extends attribute is defined, then returns the value of * the extends attribute (if unqualified, qualifying it with the package of the current class). * if either the model-extends or snapshot-extends attributes are defined, returns * the class declared as the snapshot-class with the name given by the snapshot-extends attribute * (if unspecified, assumes same as the name of the snapshot being defined) * on the class given in the model-extends attribute (if unspecified, assumes "this"), which is interpreted as follows. * * If the value of the model-extends attribute is "this", the class on which the snapshot * is defined is the current class. if the value is "super", then the class * is the superclass of the current class. otherwise, the class is given * directly by the model-extends attribute, and if unqualified, qualified by * the package of the current class * @doc.tag type="content"

Throws:
xdoclet.XDocletException

snapshotExtendsFrom

public String snapshotExtendsFrom()
                           throws xdoclet.XDocletException
returns the name of the snapshot this snapshot is extending, if it is * extending a snapshot class, null otherwise * @doc.tag type="content"

Throws:
xdoclet.XDocletException

modelExtendsFrom

public String modelExtendsFrom()
                        throws xdoclet.XDocletException
returns the model class on which the snapshot from which this snapshot is * defined. extends (assumes this extends from a snapshot) * * @doc.tag type="content" *

Throws:
xdoclet.XDocletException

modelPropertyType

public String modelPropertyType()
                         throws xdoclet.XDocletException
Returns:
the type of the current property in the model
Throws:
xdoclet.XDocletException

modelSimplePropertyNestedType

public String modelSimplePropertyNestedType()
                                     throws xdoclet.XDocletException
Returns:
the type of the current property in the model after * taking into account nested property references.
Throws:
xdoclet.XDocletException

snapshotPropertyType

public String snapshotPropertyType()
                            throws xdoclet.XDocletException
Returns:
the type of the current property in the snapshot
Throws:
xdoclet.XDocletException

snapshotPropertyName

public String snapshotPropertyName()
                            throws xdoclet.XDocletException
Returns:
the name of the current property in the snapshot
Throws:
xdoclet.XDocletException

snapshotPropertySuffix

public String snapshotPropertySuffix()
                              throws xdoclet.XDocletException
a suffix for variables based on the current property in the snapshot. basically * just snapshotPropertyName() with the first letter capitalized * @return * @throws XDocletException

Throws:
xdoclet.XDocletException

modelPropertyName

public String modelPropertyName()
                         throws xdoclet.XDocletException
Returns:
the name of the current property in the model
Throws:
xdoclet.XDocletException

snapshotPropertyVar

public String snapshotPropertyVar()
                           throws xdoclet.XDocletException
Returns:
the variable name to use for the current property in the snapshot
Throws:
xdoclet.XDocletException

initValue

public String initValue()
                 throws xdoclet.XDocletException
Throws:
xdoclet.XDocletException

snapshotSimplePropertyTransformer

public String snapshotSimplePropertyTransformer()
                                         throws xdoclet.XDocletException
Returns:
the class name of the transformer to transform model value to * snapshot value *
Throws:
xdoclet.XDocletException

snapshotSimplePropertyTransformerArgs

public String snapshotSimplePropertyTransformerArgs()
                                             throws xdoclet.XDocletException
Returns:
the arguments for the snapshot transformer suitable for passing * to TransformUtils *
Throws:
xdoclet.XDocletException

snapshotSimplePropertyTargetType

public String snapshotSimplePropertyTargetType()
                                        throws xdoclet.XDocletException
Returns:
explicitly specified type for propeties when using * explicit transformations, or else null.
Throws:
xdoclet.XDocletException

modelSimplePropertyTransformer

public String modelSimplePropertyTransformer()
                                      throws xdoclet.XDocletException
Returns:
the class name of the transformer to transform model value to * snapshot value
Throws:
xdoclet.XDocletException

modelSimplePropertyTransformerArgs

public String modelSimplePropertyTransformerArgs()
                                          throws xdoclet.XDocletException
Returns:
the arguments for the snapshot transformer suitable for passing * to TransformUtils *
Throws:
xdoclet.XDocletException

simplePropertyNestedProperty

public String simplePropertyNestedProperty()
                                    throws xdoclet.XDocletException
Returns:
the value of the element-nested-property param
Throws:
xdoclet.XDocletException

modelGetter

public String modelGetter()
                   throws xdoclet.XDocletException
Return the string that should be used to get the value of the model * property.

Throws:
xdoclet.XDocletException

snapshotGetter

public String snapshotGetter()
                      throws xdoclet.XDocletException
Returns:
the string that should be used to get the value of the snapshot * property. the expected template usage is snapshotObject.();
Throws:
xdoclet.XDocletException

snapshotGetterAccess

public String snapshotGetterAccess()
                            throws xdoclet.XDocletException
Returns:
the access modifier for the getter in the snapshot. by default it is * the same as in the model
Throws:
xdoclet.XDocletException

modelSetter

public String modelSetter()
                   throws xdoclet.XDocletException
Returns:
the string that should be used to set the value of the model * property. the expected template usage is modelObject.();
Throws:
xdoclet.XDocletException

snapshotSetter

public String snapshotSetter()
                      throws xdoclet.XDocletException
Returns:
the string that should be used to set the value of the snapshot * property. the expected template usage is snapshotObject.();
Throws:
xdoclet.XDocletException

snapshotSetterAccess

public String snapshotSetterAccess()
                            throws xdoclet.XDocletException
Returns:
the access modifier for the setter in the snapshot. assumes * that the value is not "none"
Throws:
xdoclet.XDocletException

mapKeySnapshotName

public String mapKeySnapshotName()
                          throws xdoclet.XDocletException
Returns:
the key of the snapshot to use on the keys of the current map
Throws:
xdoclet.XDocletException

mapValueSnapshotName

public String mapValueSnapshotName()
                            throws xdoclet.XDocletException
Returns:
the key of the snapshot to use on the values of the current map
Throws:
xdoclet.XDocletException

snapshotMapKeyTargetType

public String snapshotMapKeyTargetType()
                                throws xdoclet.XDocletException
Returns:
the type for the map keys in the snapshot
Throws:
xdoclet.XDocletException

snapshotMapKeyTransformer

public String snapshotMapKeyTransformer()
                                 throws xdoclet.XDocletException
Returns:
the class name of the transformer to transform model map key to * snapshot map key
Throws:
xdoclet.XDocletException

snapshotMapKeyTransformerArgs

public String snapshotMapKeyTransformerArgs()
                                     throws xdoclet.XDocletException
Returns:
the arguments for the snapshot transformer for model map keys suitable for passing * to TransformUtils *
Throws:
xdoclet.XDocletException

snapshotMapValueTargetType

public String snapshotMapValueTargetType()
                                  throws xdoclet.XDocletException
Returns:
the type for the map value in the snapshot
Throws:
xdoclet.XDocletException

snapshotMapValueTransformer

public String snapshotMapValueTransformer()
                                   throws xdoclet.XDocletException
Returns:
the class name of the transformer to transform model map value * to snapshot map value
Throws:
xdoclet.XDocletException

snapshotMapValueTransformerArgs

public String snapshotMapValueTransformerArgs()
                                       throws xdoclet.XDocletException
Returns:
the arguments for the snapshot transformer for model map values suitable for passing * to TransformUtils *
Throws:
xdoclet.XDocletException

snapshotMapExplicitCreateExpr

public String snapshotMapExplicitCreateExpr()
                                     throws xdoclet.XDocletException
Returns:
the explicit expression for creating the map in the snapshot, * if specified * @throws XDocletException
Throws:
xdoclet.XDocletException

modelMapKeyTransformer

public String modelMapKeyTransformer()
                              throws xdoclet.XDocletException
Returns:
the class name of the transformer to transform snapshot map key to * model map key
Throws:
xdoclet.XDocletException

modelMapKeyTransformerArgs

public String modelMapKeyTransformerArgs()
                                  throws xdoclet.XDocletException
Returns:
the arguments for the model transformer for snapshot map keys suitable for passing * to TransformUtils *
Throws:
xdoclet.XDocletException

modelMapKeyType

public String modelMapKeyType()
                       throws xdoclet.XDocletException
Throws:
xdoclet.XDocletException

modelMapKeyNestedType

public String modelMapKeyNestedType()
                             throws xdoclet.XDocletException
Returns:
the class name of the type of keys in the model map after * applying the nested property. only makes sense if using nested property for * the keys. Is not necessary; if no type explicitly specified, return null. * @throws XDocletException
Throws:
xdoclet.XDocletException

mapKeyNestedProperty

public String mapKeyNestedProperty()
                            throws xdoclet.XDocletException
Returns:
the value of the map-key-nested-property param *
Throws:
xdoclet.XDocletException

modelMapValueTransformer

public String modelMapValueTransformer()
                                throws xdoclet.XDocletException
Returns:
the class name of the transformer to transform snapshot map value * to model map value
Throws:
xdoclet.XDocletException

modelMapValueTransformerArgs

public String modelMapValueTransformerArgs()
                                    throws xdoclet.XDocletException
Returns:
the arguments for the model transformer for snapshot map values suitable for passing * to TransformUtils *
Throws:
xdoclet.XDocletException

mapValueNestedProperty

public String mapValueNestedProperty()
                              throws xdoclet.XDocletException
Returns:
the value of the map-value-expr param
Throws:
xdoclet.XDocletException

modelMapValueType

public String modelMapValueType()
                         throws xdoclet.XDocletException
Throws:
xdoclet.XDocletException

modelMapValueNestedType

public String modelMapValueNestedType()
                               throws xdoclet.XDocletException
Returns:
the class name of the type of values in the model map after * applying the nested property. only makes sense if using nested property for * the values. Is not necessary; if no type explicitly specified, return null. * @throws XDocletException
Throws:
xdoclet.XDocletException

modelMapExplicitCreateExpr

public String modelMapExplicitCreateExpr()
                                  throws xdoclet.XDocletException
Returns:
the explicit expression for creating the map in the model, * if specified * @throws XDocletException
Throws:
xdoclet.XDocletException

modelCollectionArrayElementType

public String modelCollectionArrayElementType()
                                       throws xdoclet.XDocletException
Throws:
xdoclet.XDocletException

modelCollectionArrayElementNestedType

public String modelCollectionArrayElementNestedType()
                                             throws xdoclet.XDocletException
Returns:
the class name of the type of elements in the model collection after * applying the nested property. only makes sense if using nested property for * the elements. Is not necessary; if no type explicitly specified, return null. * @throws XDocletException
Throws:
xdoclet.XDocletException

modelCollectionArrayExplicitCreateExpr

public String modelCollectionArrayExplicitCreateExpr()
                                              throws xdoclet.XDocletException
Returns:
the explicit expression for creating the collection in the model, * if specified * @throws XDocletException
Throws:
xdoclet.XDocletException

snapshotArrayElementType

public String snapshotArrayElementType()
                                throws xdoclet.XDocletException
Returns:
the type of elements inside the snapshot array
Throws:
xdoclet.XDocletException

snapshotCollectionArrayElementTargetType

public String snapshotCollectionArrayElementTargetType()
                                                throws xdoclet.XDocletException
Returns:
the type of elements inside the snapshot array specified explicitly * by an attribute; or else "null"
Throws:
xdoclet.XDocletException

collectionArrayElementSnapshotName

public String collectionArrayElementSnapshotName()
                                          throws xdoclet.XDocletException
Returns:
the name of the snapshot on the model property collection's * elements to use figure out the classname of the objects contained * in the snapshot property's collection or array *
Throws:
xdoclet.XDocletException

snapshotCollectionArrayElementTransformer

public String snapshotCollectionArrayElementTransformer()
                                                 throws xdoclet.XDocletException
Returns:
the class name of the transformer to transform model collection * element to snapshot collection element
Throws:
xdoclet.XDocletException

snapshotCollectionArrayElementTransformerArgs

public String snapshotCollectionArrayElementTransformerArgs()
                                                     throws xdoclet.XDocletException
Returns:
the arguments for the snapshot transformer for model collection elements suitable for passing * to TransformUtils *
Throws:
xdoclet.XDocletException

modelCollectionArrayElementTransformer

public String modelCollectionArrayElementTransformer()
                                              throws xdoclet.XDocletException
Returns:
the class name of the transformer to transform snapshot collection * element to model collection element
Throws:
xdoclet.XDocletException

modelCollectionArrayElementTransformerArgs

public String modelCollectionArrayElementTransformerArgs()
                                                  throws xdoclet.XDocletException
Returns:
the arguments for the model transformer for snapshot collection elements suitable for passing * to TransformUtils *
Throws:
xdoclet.XDocletException

collectionArrayElementNestedProperty

public String collectionArrayElementNestedProperty()
                                            throws xdoclet.XDocletException
Returns:
the value of the element-nested-property param
Throws:
xdoclet.XDocletException

snapshotCollectionArrayExplicitCreateExpr

public String snapshotCollectionArrayExplicitCreateExpr()
                                                 throws xdoclet.XDocletException
Returns:
the explicit expression for creating the collection in the snapshot, * if specified * @throws XDocletException
Throws:
xdoclet.XDocletException

simplePropertySnapshotName

public String simplePropertySnapshotName()
                                  throws xdoclet.XDocletException
Returns:
the name of the snapshot on the model property's type to use to * figure out the classname of the snapshot property
Throws:
xdoclet.XDocletException

ifExtendsFromSnapshot

public void ifExtendsFromSnapshot(String template)
                           throws xdoclet.XDocletException
runs the contained template if this snapshot extends from another * snapshot

Throws:
xdoclet.XDocletException

ifNotExtendsFromObject

public void ifNotExtendsFromObject(String template)
                            throws xdoclet.XDocletException
runs the contained template if this snapshot extends from a class * other than java.lang.Object.

Throws:
xdoclet.XDocletException

defaultConcreteMapType

public void defaultConcreteMapType(String template)
                            throws xdoclet.XDocletException
output the default concerte map class for the map class generated by the * contained template * @param template * @throws XDocletException

Throws:
xdoclet.XDocletException

defaultConcreteCollectionType

public void defaultConcreteCollectionType(String template)
                                   throws xdoclet.XDocletException
output the default concrete collection class for the collection class * generated by the contained template * @param template * @return * @throws XDocletException

Throws:
xdoclet.XDocletException

ifMatchesSnapshot

public void ifMatchesSnapshot(String template)
                       throws xdoclet.XDocletException
runs the contained template if the current * xsnapshot.[property,collection,map] tag's match attribute matches the * current snapshot. It matches if it either equal to "*" or is a series of * comma-separated strings on of which is key of the current snapshot

Throws:
xdoclet.XDocletException

ifHasInitValue

public void ifHasInitValue(String template)
                    throws xdoclet.XDocletException
TODO: figure out correct behavior for collections, maps * runs the contained template if the current * xsnapshot.[property,collection,map] tag has an init-value specified * @param template * * @throws XDocletException *

Throws:
xdoclet.XDocletException

ifHasSnapshotGetter

public void ifHasSnapshotGetter(String template)
                         throws xdoclet.XDocletException
runs the contained template if the current * property should have a getter in the snapshot * * @throws XDocletException *

Throws:
xdoclet.XDocletException

ifHasSnapshotSetter

public void ifHasSnapshotSetter(String template)
                         throws xdoclet.XDocletException
runs the contained template if the current * property should have a setter in the snapshot * * @throws XDocletException *

Throws:
xdoclet.XDocletException

ifCanUseDirectModelGetter

public void ifCanUseDirectModelGetter(String template)
                               throws xdoclet.XDocletException
runs the contained template if the current * property's model value can be obtained by direct call to the getter. This * is the case if the getter is public * * @throws XDocletException *

Throws:
xdoclet.XDocletException

ifNotCanUseDirectModelGetter

public void ifNotCanUseDirectModelGetter(String template)
                                  throws xdoclet.XDocletException
runs the contained template if the current * property's model value cannot be obtained by direct call to the getter. * * @throws XDocletException *

Throws:
xdoclet.XDocletException

ifCanUseDirectModelSetter

public void ifCanUseDirectModelSetter(String template)
                               throws xdoclet.XDocletException
runs the contained template if the current * property's model value can be set by direct call to the setter. This * is the case if the setter exists and is public * * @throws XDocletException *

Throws:
xdoclet.XDocletException

ifNotCanUseDirectModelSetter

public void ifNotCanUseDirectModelSetter(String template)
                                  throws xdoclet.XDocletException
runs the contained template if the current * property's model value cannot be set by direct call to the setter. * * @throws XDocletException *

Throws:
xdoclet.XDocletException

ifCanUseDirectSnapshotGetter

public void ifCanUseDirectSnapshotGetter(String template)
                                  throws xdoclet.XDocletException
runs the contained template if the current * property's snapshot value can be obtained by direct call to the getter. This * is the case if the snapshot has a getter for the property and it is public * * @throws XDocletException *

Throws:
xdoclet.XDocletException

ifNotCanUseDirectSnapshotGetter

public void ifNotCanUseDirectSnapshotGetter(String template)
                                     throws xdoclet.XDocletException
runs the contained template if the current * property's snapshot value cannot be obtained by direct call to the getter. * * @throws XDocletException *

Throws:
xdoclet.XDocletException

ifCanUseDirectSnapshotSetter

public void ifCanUseDirectSnapshotSetter(String template)
                                  throws xdoclet.XDocletException
runs the contained template if the current * property's snapshot value can be set by direct call to the setter. This * is the case if the setter exists and is public * * @throws XDocletException *

Throws:
xdoclet.XDocletException

ifNotCanUseDirectSnapshotSetter

public void ifNotCanUseDirectSnapshotSetter(String template)
                                     throws xdoclet.XDocletException
runs the contained template if the current * property's snapshot value cannot be set by direct call to the setter. * * @throws XDocletException *

Throws:
xdoclet.XDocletException

ifModelPropertyIsArray

public void ifModelPropertyIsArray(String template)
                            throws xdoclet.XDocletException
runs the contained template if the current property in the model is array-valued * @param template * @throws XDocletException

Throws:
xdoclet.XDocletException

ifNotModelPropertyIsArray

public void ifNotModelPropertyIsArray(String template)
                               throws xdoclet.XDocletException
runs the contained template if the current property in the model is array-valued * @param template * @throws XDocletException

Throws:
xdoclet.XDocletException

ifShouldCopySnapshotToModel

public void ifShouldCopySnapshotToModel(String template)
                                 throws xdoclet.XDocletException
runs the contained template if this property should be copied over * when copying snapshot to model. The decision process is: * *
  • if the copy-to-model is set, then its value determines whether the * property * is copied over, or not. * *
  • if copy-to-model is not set, the policy set by the * copy-to-model-policy * tag on the snapshot-class tag is used. If that tag is not set, the default * policy specified by the helper subtask is used. if that is not set, the * "conservative" policy is used. See user guide for descriptions of the * different policies.

    Throws:
    xdoclet.XDocletException

    • ifNotShouldCopySnapshotToModel

    public void ifNotShouldCopySnapshotToModel(String template)
                                    throws xdoclet.XDocletException
    runs the contained template if this property should NOT be copied over * when copying snapshot to model. See javadoc for ifShouldCopySnapshotToModel * for how this decision is made. * @param template * @throws XDocletException

    Throws:
    xdoclet.XDocletException

    ifSimplePropertyUsesTypeConversion

    public void ifSimplePropertyUsesTypeConversion(String template)
                                        throws xdoclet.XDocletException
    Runs the contained template if this current property tag requires type * conversion

    Throws:
    xdoclet.XDocletException

    ifNotSimplePropertyUsesTypeConversion

    public void ifNotSimplePropertyUsesTypeConversion(String template)
                                           throws xdoclet.XDocletException
    Runs the contained template if this current field does not require type * covnersion

    Throws:
    xdoclet.XDocletException

    ifSimplePropertyUsesSnapshot

    public void ifSimplePropertyUsesSnapshot(String template)
                                  throws xdoclet.XDocletException
    Runs the contained template if this current field is a * propertyReturnsSnapshot.

    Throws:
    xdoclet.XDocletException

    ifNotSimplePropertyUsesSnapshot

    public void ifNotSimplePropertyUsesSnapshot(String template)
                                     throws xdoclet.XDocletException
    Runs the contained template if this current field is not a * propertyReturnsSnapshot.

    Throws:
    xdoclet.XDocletException

    ifSimplePropertyUsesNestedProperty

    public void ifSimplePropertyUsesNestedProperty(String template)
                                        throws xdoclet.XDocletException
    Runs the contained template if the current collection/array tag specifies * a element-expr

    Throws:
    xdoclet.XDocletException

    ifNotSimplePropertyUsesNestedProperty

    public void ifNotSimplePropertyUsesNestedProperty(String template)
                                           throws xdoclet.XDocletException
    Runs the contained template if the current collection/array tag specifies * a element-expr

    Throws:
    xdoclet.XDocletException

    ifModelMapExplicitCreateExpr

    public void ifModelMapExplicitCreateExpr(String template)
                                  throws xdoclet.XDocletException
    Runs the contained template if the current map tag specifies * an explicit create expr for the value of the map in the model

    Throws:
    xdoclet.XDocletException

    ifNotModelMapExplicitCreateExpr

    public void ifNotModelMapExplicitCreateExpr(String template)
                                     throws xdoclet.XDocletException
    Runs the contained template if the current map tag does not specify * an explicit create expr for the value of the map in the model

    Throws:
    xdoclet.XDocletException

    ifSnapshotMapExplicitCreateExpr

    public void ifSnapshotMapExplicitCreateExpr(String template)
                                     throws xdoclet.XDocletException
    Runs the contained template if the current map tag specifies * an explicit create expr for the value of the map in the snapshot

    Throws:
    xdoclet.XDocletException

    ifNotSnapshotMapExplicitCreateExpr

    public void ifNotSnapshotMapExplicitCreateExpr(String template)
                                        throws xdoclet.XDocletException
    Runs the contained template if the current map tag does not specify * an explicit create expr for the value of the map in the snapshot

    Throws:
    xdoclet.XDocletException

    ifMapKeyUsesSnapshot

    public void ifMapKeyUsesSnapshot(String template)
                          throws xdoclet.XDocletException
    * Runs the contained template if this current field is a mapKeyIsSnapshot. *

    Throws:
    xdoclet.XDocletException

    ifNotMapKeyUsesSnapshot

    public void ifNotMapKeyUsesSnapshot(String template)
                             throws xdoclet.XDocletException
    * Runs the contained template if this current field is not a * * mapKeyIsSnapshot. *

    Throws:
    xdoclet.XDocletException

    ifMapKeyUsesNestedProperty

    public void ifMapKeyUsesNestedProperty(String template)
                                throws xdoclet.XDocletException
    * Runs the contained template if the current map tag specifies a key-expr *

    Throws:
    xdoclet.XDocletException

    ifNotMapKeyUsesNestedProperty

    public void ifNotMapKeyUsesNestedProperty(String template)
                                   throws xdoclet.XDocletException
    * Runs the contained template if the current map tag does not specify a * * key-expr *

    Throws:
    xdoclet.XDocletException

    ifMapKeyUsesTypeConversion

    public void ifMapKeyUsesTypeConversion(String template)
                                throws xdoclet.XDocletException
    * Runs the contained template if this current map tag requires key type * * conversion *

    Throws:
    xdoclet.XDocletException

    ifNotMapKeyUsesTypeConversion

    public void ifNotMapKeyUsesTypeConversion(String template)
                                   throws xdoclet.XDocletException
    * Runs the contained template if this current map tag does not require key * * type conversion *

    Throws:
    xdoclet.XDocletException

    ifMapValueUsesSnapshot

    public void ifMapValueUsesSnapshot(String template)
                            throws xdoclet.XDocletException
    * Runs the contained template if this current field is a * * mapValueIsSnapshot. *

    Throws:
    xdoclet.XDocletException

    ifNotMapValueUsesSnapshot

    public void ifNotMapValueUsesSnapshot(String template)
                               throws xdoclet.XDocletException
    * Runs the contained template if this current field is not a * * mapValueIsSnapshot. *

    Throws:
    xdoclet.XDocletException

    ifMapValueUsesNestedProperty

    public void ifMapValueUsesNestedProperty(String template)
                                  throws xdoclet.XDocletException
    * Runs the contained template if the current map tag specifies a value-expr *

    Throws:
    xdoclet.XDocletException

    ifNotMapValueUsesNestedProperty

    public void ifNotMapValueUsesNestedProperty(String template)
                                     throws xdoclet.XDocletException
    * Runs the contained template if the current map tag does not specify a * * value-expr *

    Throws:
    xdoclet.XDocletException

    ifMapValueUsesTypeConversion

    public void ifMapValueUsesTypeConversion(String template)
                                  throws xdoclet.XDocletException
    * Runs the contained template if this current map tag requires value type * * conversion *

    Throws:
    xdoclet.XDocletException

    ifNotMapValueUsesTypeConversion

    public void ifNotMapValueUsesTypeConversion(String template)
                                     throws xdoclet.XDocletException
    * Runs the contained template if this current map tag does not require * * value type conversion *

    Throws:
    xdoclet.XDocletException

    ifModelCollectionArrayExplicitCreateExpr

    public void ifModelCollectionArrayExplicitCreateExpr(String template)
                                              throws xdoclet.XDocletException
    Runs the contained template if the current map tag specifies * an explicit create expr for the value of the map in the model

    Throws:
    xdoclet.XDocletException

    ifNotModelCollectionArrayExplicitCreateExpr

    public void ifNotModelCollectionArrayExplicitCreateExpr(String template)
                                                 throws xdoclet.XDocletException
    Runs the contained template if the current map tag does not specify * an explicit create expr for the value of the map in the model

    Throws:
    xdoclet.XDocletException

    ifSnapshotCollectionArrayExplicitCreateExpr

    public void ifSnapshotCollectionArrayExplicitCreateExpr(String template)
                                                 throws xdoclet.XDocletException
    Runs the contained template if the current map tag specifies * an explicit create expr for the value of the map in the snapshot

    Throws:
    xdoclet.XDocletException

    ifNotSnapshotCollectionArrayExplicitCreateExpr

    public void ifNotSnapshotCollectionArrayExplicitCreateExpr(String template)
                                                    throws xdoclet.XDocletException
    Runs the contained template if the current map tag does not specify * an explicit create expr for the value of the map in the snapshot

    Throws:
    xdoclet.XDocletException

    ifCollectionArrayElementUsesSnapshot

    public void ifCollectionArrayElementUsesSnapshot(String template)
                                          throws xdoclet.XDocletException
    * Runs the contained template if the current collection tag specifies that * * its elements are snapshots *

    Throws:
    xdoclet.XDocletException

    ifNotCollectionArrayElementUsesSnapshot

    public void ifNotCollectionArrayElementUsesSnapshot(String template)
                                             throws xdoclet.XDocletException
    * Runs the contained template if the current collection tag specifies that * * its elements are not snapshots *

    Throws:
    xdoclet.XDocletException

    ifCollectionArrayElementUsesNestedProperty

    public void ifCollectionArrayElementUsesNestedProperty(String template)
                                                throws xdoclet.XDocletException
    Runs the contained template if the current collection/array tag specifies * a element-expr

    Throws:
    xdoclet.XDocletException

    ifNotCollectionArrayElementUsesNestedProperty

    public void ifNotCollectionArrayElementUsesNestedProperty(String template)
                                                   throws xdoclet.XDocletException
    Runs the contained template if the current collection/array tag specifies * a element-expr

    Throws:
    xdoclet.XDocletException

    ifCollectionArrayElementUsesTypeConversion

    public void ifCollectionArrayElementUsesTypeConversion(String template)
                                                throws xdoclet.XDocletException
    Runs the contained template if this current collection/array tag requires * element type conversion

    Throws:
    xdoclet.XDocletException

    ifNotCollectionArrayElementUsesTypeConversion

    public void ifNotCollectionArrayElementUsesTypeConversion(String template)
                                                   throws xdoclet.XDocletException
    * Runs the contained template if this current collection/array tag does not * * require element type conversion *

    Throws:
    xdoclet.XDocletException

    forAllXSnapshotProperties

    public void forAllXSnapshotProperties(String template)
                               throws xdoclet.XDocletException
    * runs the specified template for all properties that should be included in * * the current snapshot *

    Throws:
    xdoclet.XDocletException

    ifGenerateEquals

    public void ifGenerateEquals(String template)
                      throws xdoclet.XDocletException
    * Runs the contained template if we are generating the equals method, i.e. * * using either reflection or enumerated strategy strategy for this class *

    Throws:
    xdoclet.XDocletException

    ifUseReflectionEquals

    public void ifUseReflectionEquals(String template)
                           throws xdoclet.XDocletException
    Runs the contained template if we are using reflection equals/hash code * strategy for this class

    Throws:
    xdoclet.XDocletException

    ifNotUseReflectionEquals

    public void ifNotUseReflectionEquals(String template)
                              throws xdoclet.XDocletException
    Runs the contained template if we are not using reflection equals/hash * code strategy for this class

    Throws:
    xdoclet.XDocletException

    ifImplementsComparable

    public void ifImplementsComparable(String template)
                            throws xdoclet.XDocletException
    runs the contained template if the current snapshot is declared to * implement the Comparable interface

    Throws:
    xdoclet.XDocletException

    forAllEqualsProperties

    public void forAllEqualsProperties(String template)
                            throws xdoclet.XDocletException
    Runs the contained template for all properties that are to be used in the * equals method generation for the current snapshot

    Throws:
    xdoclet.XDocletException

    forAllHashCodeProperties

    public void forAllHashCodeProperties(String template)
                              throws xdoclet.XDocletException
    Runs the contained template for all properties that are to be used in the * hashCode method generation for the current snapshot

    Throws:
    xdoclet.XDocletException

    forAllComparableProperties

    public void forAllComparableProperties(String template)
                                throws xdoclet.XDocletException
    Runs the contained template for all properties that are to be used in the * compareTo method generation for the current snapshot

    Throws:
    xdoclet.XDocletException

    ifGenerateToString

    public void ifGenerateToString(String template)
                        throws xdoclet.XDocletException
    Runs the contained template if we are auto-generating the toString method * for this snapshot class

    Throws:
    xdoclet.XDocletException

    ifUseReflectionToString

    public void ifUseReflectionToString(String template)
                             throws xdoclet.XDocletException
    Runs the contained template if we are using reflection equals/hash code * strategy for this class

    Throws:
    xdoclet.XDocletException

    ifNotUseReflectionToString

    public void ifNotUseReflectionToString(String template)
                                throws xdoclet.XDocletException
    Runs the contained template if we are using reflection equals/hash code * strategy for this class

    Throws:
    xdoclet.XDocletException

    forAllToStringProperties

    public void forAllToStringProperties(String template)
                              throws xdoclet.XDocletException
    Throws:
    xdoclet.XDocletException

    defaultValueForType

    public void defaultValueForType(String template)
                         throws xdoclet.XDocletException
    Throws:
    xdoclet.XDocletException

    conversionMethodForType

    public void conversionMethodForType(String template)
                             throws xdoclet.XDocletException
    Throws:
    xdoclet.XDocletException

    ifCurrentTagIsSimpleProperty

    public void ifCurrentTagIsSimpleProperty(String template)
                                  throws xdoclet.XDocletException
    Throws:
    xdoclet.XDocletException

    ifCurrentTagIsArrayOrCollection

    public void ifCurrentTagIsArrayOrCollection(String template,
                                            Properties attrs)
                                     throws xdoclet.XDocletException
    Throws:
    xdoclet.XDocletException

    ifCurrentTagIsArray

    public void ifCurrentTagIsArray(String template)
                         throws xdoclet.XDocletException
    Throws:
    xdoclet.XDocletException

    ifCurrentTagIsCollection

    public void ifCurrentTagIsCollection(String template,
                                     Properties attrs)
                              throws xdoclet.XDocletException
    Throws:
    xdoclet.XDocletException

    ifCurrentTagIsMap

    public void ifCurrentTagIsMap(String template,
                              Properties attrs)
                       throws xdoclet.XDocletException
    Throws:
    xdoclet.XDocletException

    mergeForSnapshot

    public void mergeForSnapshot(String template)
                      throws xdoclet.XDocletException
    Throws:
    xdoclet.XDocletException

    ifGenerateHelper

    public void ifGenerateHelper(String template)
                      throws xdoclet.XDocletException
    Evaluate the template if we are generating the current helper. * Normally true by default. * @param template the template to evaluate

    Throws:
    xdoclet.XDocletException
    Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
     PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
    SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD