Module io.sf.jclf.text

Package io.sf.jclf.text.format

Class StringFormat

java.lang.Object

io.sf.jclf.text.format.ObjectFormat

io.sf.jclf.text.format.StringFormat

All Implemented Interfaces:

Alignable

public class StringFormat
extends ObjectFormat

Field Summary

Fields inherited from class io.sf.jclf.text.format.ObjectFormat

flags, precision, ralign, width

Fields inherited from interface io.sf.jclf.doc.style.Alignable

CENTER, JUSTIFY, LEFT, RIGHT, UNDETERMINED

Constructor Summary

Constructors

Constructor	Description
StringFormat()

Method Summary

Modifier and Type	Method	Description
String	format(Object o)	Formats an object according to the format specification set by setFormat.
Object	sample()	Produce a sample of this format.
protected char	setFormat(String format)	Sets the format of the object.
String	toString()

Methods inherited from class io.sf.jclf.text.format.ObjectFormat

align, create, create, create, expandLeftToWidth, expandRightToWidth, getAlignment, rightAppend, setFlag, setFlags

Methods inherited from class java.lang.Object

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

Constructor Details

StringFormat

public StringFormat()

Method Details

setFormat

protected char setFormat(String format)
                  throws SpecParsingException

Description copied from class: ObjectFormat

Sets the format of the object.

Overrides:

setFormat in class ObjectFormat

Parameters:

format - the format.

Returns:

the format type

Throws:

SpecParsingException - if the format contains unknown or wrong format specs.

format

public String format(Object o)

Description copied from class: ObjectFormat

Formats an object according to the format specification set by setFormat.

Must be overriden by subclasses.

Specified by:

format in class ObjectFormat

Parameters:

o - the object to be formatted.

Returns:

a string with the formatted object.

toString

public String toString()

Overrides:

toString in class Object

sample

public Object sample()

Description copied from class: ObjectFormat

Produce a sample of this format.

Specified by:

sample in class ObjectFormat

Returns:

a String with a (more or less) random object appropriate to be formatted according to current format specifications.