net.sf.fikin.pojostate
Class StateFormat

java.lang.Object
  java.text.Format
      net.sf.fikin.pojostate.StateFormat

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

PropertiesStateFormat

public abstract class StateFormat
extends java.text.Format

Format a State object to a string.

it enhances the original java.text.Format with formatting method accepting output object. created on Mar 9, 2007

Since:

Version:

$Revision: 1.1 $

Author:

fiykov

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.text.Format

java.text.Format.Field

Constructor Summary

StateFormat()

Method Summary

abstract void

format(java.lang.Object obj, java.lang.Object out) Formats an object to produce a string.

Methods inherited from class java.text.Format

clone, format, format, formatToCharacterIterator, parseObject, parseObject

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StateFormat

public StateFormat()

Method Detail

format

public abstract void format(java.lang.Object obj,
                            java.lang.Object out)
                     throws java.lang.IllegalArgumentException,
                            java.io.IOException

Formats an object to produce a string. This is equivalent to

Format.format(Object)

but outputting directly to the given output object.

Parameters:

obj - The object to format

out - The object to print the text to directly. Actual type of this object is determined by the actual StateFormat implementation. Typically they are expected to implement support for at least Writer and OutputStream types.

Throws:

java.lang.IllegalArgumentException - if the Format cannot format the given object or out object type is not supported.

java.io.IOException - in case when writting to output object failed