com.codestreet.messageforge
Class RFldHashtable

java.lang.Object
  com.codestreet.messageforge.RFld
      com.codestreet.messageforge.RFldHashtable

All Implemented Interfaces:

RFldInterface, java.io.Serializable

Direct Known Subclasses:

RFldMsgObjHashtable, RFldStringHashtable

public abstract class RFldHashtable

extends RFld

Class to represent a hashtable field.

Author:

Jawaid Hakim.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.codestreet.messageforge.RFld

desc_, fieldId_, locked_, name_, optional_, propertyName_, tags_, transient_, valSet_

Constructor Summary

	RFldHashtable() Default constructor.
protected	RFldHashtable(java.lang.String name, int fieldId) Constructor.
protected	RFldHashtable(java.lang.String name, int fieldId, java.lang.String desc) Constructor.

Method Summary

void	marshal(java.io.Writer writer, int indentLevel, java.lang.String indent, boolean newLines, boolean expandEmptyElements) Write the field as XML to target writer.
abstract RFld	set(java.util.Hashtable newData) Set state from a java.util.Hashtable.

Methods inherited from class com.codestreet.messageforge.RFld

addConstraint, buildMinMaxConstraintKey, equals, getConstraint, getConstraintCount, getDesc, getId, getName, getOptional, getPropertyName, getTag, getTags, getTransient, getType, getValueAsString, hashCode, isConstrained, isLocked, isProperty, isValSet, marshal, reset, set, set, setId, setLocked, setName, setOptional, setPropertyName, setTags, setTransient, setXmlAttrNames, setXmlTags, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.codestreet.messageforge.RFldInterface

getValueAsHashtable, getValueAsObject

Constructor Detail

RFldHashtable

public RFldHashtable()

Default constructor.

RFldHashtable

protected RFldHashtable(java.lang.String name,
                        int fieldId)

Constructor.

Parameters:

name - Field name.

fieldId - Field id. Field ids must be either 0 to indicate that there is no id on the field, or greater. In addition, field ids must be unique within a messages - no two fields are allowed to have the same field id.

RFldHashtable

protected RFldHashtable(java.lang.String name,
                        int fieldId,
                        java.lang.String desc)

Constructor.

Parameters:

name - Field name.

fieldId - Field id. Field ids must be either 0 to indicate that there is no id on the field, or greater. In addition, field ids must be unique within a messages - no two fields are allowed to have the same field id.

desc - Field description.

Method Detail

marshal

public void marshal(java.io.Writer writer,
                    int indentLevel,
                    java.lang.String indent,
                    boolean newLines,
                    boolean expandEmptyElements)
             throws ConverterException

Write the field as XML to target writer.

Specified by:

marshal in interface RFldInterface

Overrides:

marshal in class RFld

Parameters:

writer - Output target.

indent - Indentation.

newLines - Newlines are inserted after each element if true.

expandEmptyElements - Empty elements - elements with no content - are expanded if true.

Throws:

ConverterException

set

public abstract RFld set(java.util.Hashtable newData)
                  throws FieldValidationException

Set state from a java.util.Hashtable.

Parameters:

newData - New value.

Returns:

Reference to self so method chaining can be used.

Throws:

FieldValidationException