jidefx.utils.converter

Class ConverterContext

java.lang.Object

jidefx.utils.converter.ConverterContext

All Implemented Interfaces:

java.io.Serializable

public class ConverterContext
extends java.lang.Object
implements java.io.Serializable

The ConverterContext is used by ObjectConverterManager so that for the same type, different converters can be registered since the ConverterContext is different.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static ConverterContext	CONTEXT_DEFAULT Default ConverterContext with empty name.
static java.lang.String	PROPERTY_OBJECT_CONVERTER_MANAGER Property for the ObjectConverterManager.

Constructor Summary

Constructors

Constructor and Description
ConverterContext(java.lang.String name) Creates a ConverterContext with a name.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Override equals.
static ConverterContext	getArrayConverterContext(ConverterContext context) Gets the ConverterContext which add a trailing "[]" to the context name.
static ConverterContext	getElementConverterContext(ConverterContext context) Gets the ConverterContext which removes the trailing "[]" from the context name.
java.lang.String	getName() Gets the name of the ConverterContext.
javafx.collections.ObservableMap<java.lang.Object,java.lang.Object>	getProperties() Returns an observable map of properties on this node for use primarily by application developers.
int	hashCode()
boolean	hasProperties() Tests if Node has properties.
static boolean	isArrayConverterContext(ConverterContext context) Checks if the context is for an array.
void	setName(java.lang.String name) Sets the name of the ConverterContext.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

CONTEXT_DEFAULT

public static final ConverterContext CONTEXT_DEFAULT

Default ConverterContext with empty name.

PROPERTY_OBJECT_CONVERTER_MANAGER

public static final java.lang.String PROPERTY_OBJECT_CONVERTER_MANAGER

Property for the ObjectConverterManager. If this property is set to an ObjectConverterManager instance, this instance will be used to do any string/object conversion inside the toString or fromString method. Use it along with RequiringConverterManager interface which can be implemented by the ObjectConverter.

See Also:

Constant Field Values

Constructor Detail

ConverterContext

public ConverterContext(java.lang.String name)

Creates a ConverterContext with a name.

Parameters:

name - the name of the ConverterContext

Method Detail

isArrayConverterContext

public static boolean isArrayConverterContext(ConverterContext context)

Checks if the context is for an array. By conversion, we put "[]" at the end of the ConverterContext's name if the context is for an array data type. Please note, this is a conversion only. If developer chooses to not put "[]" at the end for their own customized context, this method will fail.

Parameters:

context - the context.

Returns:

true or false.

getElementConverterContext

public static ConverterContext getElementConverterContext(ConverterContext context)

Gets the ConverterContext which removes the trailing "[]" from the context name.

Parameters:

context - the context for an array type.

Returns:

the ConverterContext for the element type of an array.

getArrayConverterContext

public static ConverterContext getArrayConverterContext(ConverterContext context)

Gets the ConverterContext which add a trailing "[]" to the context name.

Parameters:

context - the context for the element type of an array.

Returns:

the ConverterContext the array of the element type.

getName

public java.lang.String getName()

Gets the name of the ConverterContext.

Returns:

the name of the ConverterContext

setName

public void setName(java.lang.String name)

Sets the name of the ConverterContext.

Parameters:

name - the name of the ConverterContext

getProperties

public final javafx.collections.ObservableMap<java.lang.Object,java.lang.Object> getProperties()

Returns an observable map of properties on this node for use primarily by application developers.

Returns:

an observable map of properties on this node for use primarily by application developers

hasProperties

public boolean hasProperties()

Tests if Node has properties.

Returns:

true if node has properties.

equals

public boolean equals(java.lang.Object o)

Override equals. Two ConverterContexts equals as long as the name is the same.

Overrides:

equals in class java.lang.Object

Parameters:

o - object to compare.

Returns:

if two objects equal.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object