2.17.2: 2011-06-17

net.sf.basedb.util.formatter
Class IdentifiableFormatter

java.lang.Object
  extended by net.sf.basedb.util.formatter.IdentifiableFormatter
All Implemented Interfaces:
Formatter<Identifiable>

public class IdentifiableFormatter
extends Object
implements Formatter<Identifiable>

Formatter to handle Identifiable items. The formatter returns the ID of the item. This formatter can not parse strings.

Version:
2.12
Author:
Nicklas
Last modified
$Date: 2009-05-08 13:30:36 +0200 (Fri, 08 May 2009) $

Field Summary
private  String nullValue
           
 
Constructor Summary
IdentifiableFormatter()
          Create a new formatter.
IdentifiableFormatter(String nullValue)
          Create a new formatter.
 
Method Summary
 String format(Identifiable value)
          Format a value by converting it to a string.
 Identifiable parseString(String value)
          Parse a string and return a value of the correct type.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

nullValue

private String nullValue
Constructor Detail

IdentifiableFormatter

public IdentifiableFormatter()
Create a new formatter. Null values are formatted as an empty string.


IdentifiableFormatter

public IdentifiableFormatter(String nullValue)
Create a new formatter.

Parameters:
nullValue - The string to return if a null item is passed to format(Identifiable)
Method Detail

format

public String format(Identifiable value)
Description copied from interface: Formatter
Format a value by converting it to a string.

Specified by:
format in interface Formatter<Identifiable>
Parameters:
value - The value to format
Returns:
A formatted string

parseString

public Identifiable parseString(String value)
Description copied from interface: Formatter
Parse a string and return a value of the correct type. A null input string should (unless otherwise documented by a specific formatter implementation) be allowed and may return null or any other "default" value.

Specified by:
parseString in interface Formatter<Identifiable>
Parameters:
value - The string to parse
Returns:
An object
Throws:
UnsupportedOperationException - Always

2.17.2: 2011-06-17