cookxml.core.converter

Class ObjectConverter

java.lang.Object

cookxml.core.converter.ObjectConverter

All Implemented Interfaces:

Converter

public class ObjectConverter
extends java.lang.Object
implements Converter

This converter treats the string as if an pointer representing an object with id or variable names. For id objects, the syntax is "id:name" and for variable objects, the syntax is "var:name".

Note that this converter should not be added to a tag library due to the potential ambiguities it can creates. Using idref and varref are recommanded.

Since:

CookXml 1.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IDREF_PREFIX
static java.lang.String	VARREF_PREFIX

Method Summary

Modifier and Type	Method and Description
java.lang.Object	convert(java.lang.String value, cookxml.core.DecodeEngine decodeEngine) Convert a string value into an object type.
static Converter	getInstance()

Methods inherited from class java.lang.Object

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

Field Detail

IDREF_PREFIX

public static java.lang.String IDREF_PREFIX

VARREF_PREFIX

public static java.lang.String VARREF_PREFIX

Method Detail

getInstance

public static Converter getInstance()

convert

public java.lang.Object convert(java.lang.String value,
                                cookxml.core.DecodeEngine decodeEngine)
                         throws ConverterException

Description copied from interface: Converter

Convert a string value into an object type.

Specified by:

convert in interface Converter

Parameters:

value - the string value to be converted.

decodeEngine - the DecodeEngine to be used.

Returns:

the converted object.

Throws:

ConverterException