|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.text.Format
com.jgoodies.validation.tutorial.formatted.format.EmptyFormat
public final class EmptyFormat
Wraps a given Format
and adds behavior to convert to/from
the empty string. Therefore it holds an empty value that is
the counterpart of the empty string. The #format
result
of the empty value is the empty string, and the #parse
result of the empty string is the empty value. In all other cases
the formatting and parsing is forwarded to the wrapped Format.
Often the empty value is null
. For example you can wrap
a DateFormat
to format null
to an empty string
and parse the empty string to null
. Another example is
the mapping of the -1
to an empty string using a wrapped
NumberFormat
.
Examples:
new EmptyFormat(new NumberFormat()); new EmptyFormat(new NumberFormat(), -1); new EmptyFormat(DateFormat.getDateInstance()); new EmptyFormat(DateFormat.getDateInstance(DateFormat.SHORT));
Nested Class Summary |
---|
Nested classes/interfaces inherited from class java.text.Format |
---|
Format.Field |
Constructor Summary | |
---|---|
EmptyFormat(Format format)
Constructs an EmptyFormat that wraps the given format
to convert null to the empty string and vice versa. |
|
EmptyFormat(Format format,
int emptyValue)
Constructs an EmptyFormat that wraps the given format
to convert the given emptyValue to the empty string
and vice versa. |
|
EmptyFormat(Format format,
Object emptyValue)
Constructs an EmptyFormat that wraps the given format
to convert the given emptyValue to the empty string
and vice versa. |
Method Summary | |
---|---|
StringBuffer |
format(Object obj,
StringBuffer toAppendTo,
FieldPosition pos)
Formats an object and appends the resulting text to a given string buffer. |
Object |
parseObject(String source)
Parses text from the beginning of the given string to produce an object. |
Object |
parseObject(String source,
ParsePosition pos)
Parses text from a string to produce an object. |
Methods inherited from class java.text.Format |
---|
clone, format, formatToCharacterIterator |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public EmptyFormat(Format format)
EmptyFormat
that wraps the given format
to convert null
to the empty string and vice versa.
format
- the format that handles the standard casespublic EmptyFormat(Format format, Object emptyValue)
EmptyFormat
that wraps the given format
to convert the given emptyValue
to the empty string
and vice versa.
format
- the format that handles non-null
valuesemptyValue
- the representation of the empty stringpublic EmptyFormat(Format format, int emptyValue)
EmptyFormat
that wraps the given format
to convert the given emptyValue
to the empty string
and vice versa.
format
- the format that handles non-null
valuesemptyValue
- the representation of the empty stringMethod Detail |
---|
public StringBuffer format(Object obj, StringBuffer toAppendTo, FieldPosition pos)
pos
argument identifies a field used by
the format, then its indices are set to the beginning and end of
the first such field encountered.
format
in class Format
obj
- The object to formattoAppendTo
- where the text is to be appendedpos
- A FieldPosition
identifying a field
in the formatted text
toAppendTo
,
with formatted text appended
NullPointerException
- if toAppendTo
or
pos
is null
IllegalArgumentException
- if the Format cannot format the given
objectpublic Object parseObject(String source) throws ParseException
Unlike super this method returns the emptyValue
if the
source string is empty and does not throw a ParseException
.
parseObject
in class Format
source
- A String
whose beginning should be parsed.
Object
parsed from the string.
ParseException
- if the beginning of the specified string
cannot be parsed.Format.parseObject(java.lang.String)
,
JFormattedTextField.setValue(java.lang.Object)
public Object parseObject(String source, ParsePosition pos)
The method attempts to parse text starting at the index given by
pos
.
If parsing succeeds, then the index of pos
is updated
to the index after the last character used (parsing does not necessarily
use all characters up to the end of the string), and the parsed
object is returned. The updated pos
can be used to
indicate the starting point for the next call to this method.
If an error occurs, then the index of pos
is not
changed, the error index of pos
is set to the index of
the character where the error occurred, and null is returned.
parseObject
in class Format
source
- A String
, part of which should be parsed.pos
- A ParsePosition
object with index and error
index information as described above.
Object
parsed from the string. In case of
error, returns null.
NullPointerException
- if pos
is null.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |