com.github.jknack.handlebars.context

Enum MapValueResolver

java.lang.Object

java.lang.Enum<MapValueResolver>

com.github.jknack.handlebars.context.MapValueResolver

All Implemented Interfaces:

ValueResolver, Serializable, Comparable<MapValueResolver>

public enum MapValueResolver
extends Enum<MapValueResolver>
implements ValueResolver

A Map value resolver.

Since:

0.1.1

Author:

edgar.espina

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE A singleton instance.

Field Summary

Fields inherited from interface com.github.jknack.handlebars.ValueResolver

UNRESOLVED, VALUE_RESOLVERS

Method Summary

Methods

Modifier and Type	Method and Description
Set<Map.Entry<String,Object>>	propertySet(Object context) List all the properties and their values for the given object.
Object	resolve(Object context) Resolve the the context object by optionally converting the value if necessary.
Object	resolve(Object context, String name) Resolve the attribute's name in the context object.
static MapValueResolver	valueOf(String name) Returns the enum constant of this type with the specified name.
static MapValueResolver[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final MapValueResolver INSTANCE

A singleton instance.

Method Detail

values

public static MapValueResolver[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MapValueResolver c : MapValueResolver.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MapValueResolver valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

resolve

public Object resolve(Object context,
             String name)

Description copied from interface: ValueResolver

Resolve the attribute's name in the context object. If a ValueResolver.UNRESOLVED is returned, the context stack will continue with the next value resolver in the chain.

Specified by:

resolve in interface ValueResolver

Parameters:

context - The context object. Not null.

name - The attribute's name. Not null.

Returns:

A ValueResolver.UNRESOLVED is returned, the context stack will continue with the next value resolver in the chain. Otherwise, it returns the associated value.

resolve

public Object resolve(Object context)

Description copied from interface: ValueResolver

Resolve the the context object by optionally converting the value if necessary. If a ValueResolver.UNRESOLVED is returned, the context stack will continue with the next value resolver in the chain.

Specified by:

resolve in interface ValueResolver

Parameters:

context - The context object. Not null.

Returns:

A ValueResolver.UNRESOLVED is returned, the context stack will continue with the next value resolver in the chain. Otherwise, it returns the associated value.

propertySet

public Set<Map.Entry<String,Object>> propertySet(Object context)

Description copied from interface: ValueResolver

List all the properties and their values for the given object.

Specified by:

propertySet in interface ValueResolver

Parameters:

context - The context object. Not null.

Returns:

All the properties and their values for the given object.