com.codestreet.messageforge
Class RFldBool

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

All Implemented Interfaces:

RFldInterface, java.io.Serializable

public class RFldBool

extends RFld

Class to represent a boolean field.

Author:

Jawaid Hakim.

See Also:

Serialized Form

Field Summary

protected java.lang.Boolean	dataObj_ Data.
protected static java.lang.String	XML_TAG XML tag for this element type.

Fields inherited from class com.codestreet.messageforge.RFld

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

Constructor Summary

RFldBool(java.lang.String name, int fieldId)
Constructor.

RFldBool(java.lang.String name, int fieldId, java.lang.String desc)
Constructor.

Method Summary

boolean	equals(java.lang.Object anObject) Check if another field is equal to this field.
java.lang.String	getTag() Get the XML tag for this field type.
RFldType	getType() Get field type.
boolean	getValue() Get data.
java.util.Hashtable	getValueAsHashtable() Get the field value as a java.util.Hashtable.
java.lang.Object	getValueAsObject() Get the field value as an object.
java.lang.String	getValueAsString() Get the field value as a string.
int	hashCode() Returns a hash code for this field.
void	reset() Reset the field value.
RFldBool	set(boolean newData) Set data.
RFldBool	set(java.lang.Boolean newData) Set data.
RFld	set(org.jdom.Element elem) Set the field value from a JDOM element.
RFld	set(java.lang.Object newData) Set data.
static void	setTag(java.lang.String tag) Set the XML tag for this field type.
void	validate() Validate against constraints.
void	validate(boolean newData) Check if a new value will satifsy constraints.

Methods inherited from class com.codestreet.messageforge.RFld

addConstraint, buildMinMaxConstraintKey, getConstraint, getConstraintCount, getDesc, getId, getName, getOptional, getPropertyName, getTags, getTransient, isConstrained, isLocked, isProperty, isValSet, marshal, marshal, setId, setLocked, setName, setOptional, setPropertyName, setTags, setTransient, setXmlAttrNames, setXmlTags

Methods inherited from class java.lang.Object

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

Field Detail

XML_TAG

protected static transient java.lang.String XML_TAG

XML tag for this element type.

dataObj_

protected java.lang.Boolean dataObj_

Data.

Constructor Detail

RFldBool

public RFldBool(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.

RFldBool

public RFldBool(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

getType

public final RFldType getType()

Get field type.

Specified by:

getType in interface RFldInterface

Specified by:

getType in class RFld

Returns:

Field type BOOL.

See Also:

RFldType

equals

public final boolean equals(java.lang.Object anObject)

Check if another field is equal to this field. Equality is defined as the fields having the same value.

Specified by:

equals in class RFld

Parameters:

anObject - Another field.

Returns:

true if another field is equal to this field. Otherwise, returns false.

hashCode

public final int hashCode()

Returns a hash code for this field. This implementation is the same as for java.lang.Boolean.

Specified by:

hashCode in class RFld

Returns:

the integer 17 if this object represents true; returns the integer 19 if this object represents false. If this field has not been set then returns 1231.

reset

public final void reset()
                 throws FieldValidationException

Reset the field value.

Specified by:

reset in class RFld

Throws:

FieldValidationException

See Also:

RFld.isValSet()

set

public final RFld set(java.lang.Object newData)
               throws FieldValidationException

Set data.

Specified by:

set in interface RFldInterface

Specified by:

set in class RFld

Parameters:

newData - New data.

Returns:

Reference to self so method chaining can be used.

Throws:

FieldValidationException

set

public final RFldBool set(boolean newData)
                   throws FieldValidationException

Set data.

Parameters:

newData - New data.

Returns:

Reference to self so method chaining can be used.

Throws:

FieldValidationException

set

public final RFld set(org.jdom.Element elem)
               throws FieldValidationException

Set the field value from a JDOM element.

Specified by:

set in interface RFldInterface

Specified by:

set in class RFld

Parameters:

elem - Field value as a JDOM element.

Returns:

Reference to self so method chaining can be used.

Throws:

FieldValidationException

set

public final RFldBool set(java.lang.Boolean newData)
                   throws FieldValidationException

Set data.

Parameters:

newData - New data.

Returns:

Reference to self so method chaining can be used.

Throws:

java.lang.NullPointerException - if the new data is null.

FieldValidationException

validate

public final void validate()
                    throws FieldValidationException

Validate against constraints. A field is valid if either it's value is set and satisfies all constraints, or the the field is optional.

Specified by:

validate in class RFld

Throws:

FieldValidationException

validate

public final void validate(boolean newData)
                    throws FieldValidationException

Check if a new value will satifsy constraints.

Parameters:

newData - New value.

Throws:

FieldValidationException

getValue

public final boolean getValue()

Get data.

Returns:

Field value.

Throws:

java.lang.NullPointerException - if the field value is not set.

getValueAsObject

public final java.lang.Object getValueAsObject()

Get the field value as an object. Returns null if the field value is not set.

Returns:

Field value as an object. Returns null if the field value is not set.

getValueAsString

public final java.lang.String getValueAsString()

Get the field value as a string. Returns false if the field value is not set.

Specified by:

getValueAsString in class RFld

Returns:

Field value as a string. Returns null if the field value is not set.

Throws:

java.lang.NullPointerException - if the field value is not set.

getValueAsHashtable

public final java.util.Hashtable getValueAsHashtable()
                                              throws FieldValidationException

Get the field value as a java.util.Hashtable. Not supported - throws an exception.

Returns:

Field value as java.util.Hashtable. Returns null if the field value is not set.

Throws:

FieldValidationException

getTag

public final java.lang.String getTag()

Get the XML tag for this field type.

Specified by:

getTag in class RFld

Returns:

XML tag for this field type.

setTag

public static void setTag(java.lang.String tag)

Set the XML tag for this field type.

Parameters:

tag - New XML tag for this field type.