public class

ObjectStringConverter

extends Object
implements Serializable
java.lang.Object
   ↳ org.apache.commons.betwixt.strategy.ObjectStringConverter
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

Strategy class for string <-> object conversions. Implementations of this interface are used by Betwixt to perform string <-> object conversions. This performs only the most basic conversions. Most applications will use a subclass.

It is strongly recommended that (in order to support round tripping) that objectToString and stringToObject are inverse functions. In other words, given the same flavour, context and type the applying objectToString to the result of stringToObject should be equal to the original input.

Summary

Constants
String FLAVOUR_OPTION_NAME Standard name for option giving flavour
Public Constructors
ObjectStringConverter()
Public Methods
String objectToString(Object object, Class type, Context context)
Converts an object to a string representation.
String objectToString(Object object, Class type, String flavour, Context context)
This method is deprecated. 0.7 use objectToString(Object, Class, Context) instead. The preferred way to support flavours is by setting the org.apache.commons.betwixt.FLAVOUR option. This can then be retrieved by calling getOptions()
Object stringToObject(String value, Class type, String flavour, Context context)
This method is deprecated. 0.7 use stringToObject(String, Class, Context) instead. The preferred way to support flavours is by setting the org.apache.commons.betwixt.FLAVOUR option. This can then be retrieved by calling getOptions()
Object stringToObject(String value, Class type, Context context)
Converts a string representation to an object.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final String FLAVOUR_OPTION_NAME

Standard name for option giving flavour

Constant Value: "org.apache.commons.betwixt.flavour"

Public Constructors

public ObjectStringConverter ()

Public Methods

public String objectToString (Object object, Class type, Context context)

Converts an object to a string representation. This basic implementation returns object.toString() or an empty string if the given object is null.

Parameters
object the object to be converted, possibly null
type the property class of the object, not null
context the context, not null
Returns
  • a String representation, not null

public String objectToString (Object object, Class type, String flavour, Context context)

This method is deprecated.
0.7 use objectToString(Object, Class, Context) instead. The preferred way to support flavours is by setting the org.apache.commons.betwixt.FLAVOUR option. This can then be retrieved by calling getOptions()

Converts an object to a string representation. This basic implementation returns object.toString() or an empty string if the given object is null.

Parameters
object the object to be converted, possibly null
type the property class of the object, not null
flavour a string allow symantic differences in formatting to be communicated
context the context, not null
Returns
  • a String representation, not null

public Object stringToObject (String value, Class type, String flavour, Context context)

This method is deprecated.
0.7 use stringToObject(String, Class, Context) instead. The preferred way to support flavours is by setting the org.apache.commons.betwixt.FLAVOUR option. This can then be retrieved by calling getOptions()

Converts a string representation to an object. It is acceptable for an implementation to return the string if it cannot convert the string to the given class type. This basic implementation just returns a string.

Parameters
value the String to be converted
type the property class to be returned (if possible), not null
flavour a string allow symantic differences in formatting to be communicated
context the context, not null
Returns
  • an Object converted from the String, not null

public Object stringToObject (String value, Class type, Context context)

Converts a string representation to an object. It is acceptable for an implementation to return the string if it cannot convert the string to the given class type. This basic implementation just returns a string.

Parameters
value the String to be converted
type the property class to be returned (if possible), not null
context the context, not null
Returns
  • an Object converted from the String, not null