Package com.palantir.ptoss.cinch.core

Class BindingContext

java.lang.Object

com.palantir.ptoss.cinch.core.BindingContext

public class BindingContext
extends Object

A BindingContext holds information about how to bind various parts of a Java Object.

Binding Constants - TODO

Visibility - TODO

Subclassing - TODO

Bindable models - have to be final

Constructor Summary

Constructors

Constructor	Description
BindingContext(Object object)	Create a BindingContext for the given, non-null object.

Method Summary

Modifier and Type	Method	Description
Object	evalOnObject(String on, BindableModel model)
ObjectFieldMethod	findGetter(String property)
static List<Class<?>>	findModelUpdateClass(BindableModel modelClass)	Returns the list of ModelUpdate types in this binding context.
static ModelUpdate	findOnObject(String on, BindableModel model)	Resolves a string reference, as specified in the on parameter of a Bound annotation to an Enum object in this runtime.
ObjectFieldMethod	findSetter(String property)
List<Field>	getAnnotatedFields(Class<? extends Annotation> klass)
List<ObjectFieldMethod>	getAnnotatedParameterlessMethods(Class<? extends Annotation> annotation)
Object	getBindableConstant(String key)	Gets a constant from the binding context.
ObjectFieldMethod	getBindableMethod(String key)	Looks up an ObjectFieldMethod tuple by its key.
BindableModel	getBindableModel(String key)
ObjectFieldMethod	getBindableModelMethod(String key)	Looks up an ObjectFieldMethod tuple by its key.
Set<BindableModel>	getBindableModels()
<T> T	getFieldObject(Field field, Class<T> klass)	Returns the value of the specified Field on the object bound by this BindingContext
static List<Object>	getOnObjects(String[] ons, BindableModel model)
static <T extends Enum<?> & ModelUpdate> boolean	isOn(Object onObject, T... changed)
static <T extends Enum<?> & ModelUpdate> boolean	isOn(Collection<Object> ons, T... changed)

Methods inherited from class java.lang.Object

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

Constructor Details

BindingContext

public BindingContext(Object object)

Create a BindingContext for the given, non-null object. Throws a BindingException if there is a problem.

Parameters:

object - the object - cannot be null

Method Details

getBindableConstant

public Object getBindableConstant(String key)

Gets a constant from the binding context. Constants are static, final fields of the bound object.

Parameters:

key - the name of the field

Returns:

the value of the field

getFieldObject

public <T> T getFieldObject(Field field,
 Class<T> klass)
                     throws IllegalArgumentException

Returns the value of the specified Field on the object bound by this BindingContext

Parameters:

field - Field to pull the value from

klass - return type of value in the Field

Returns:

value of type klass from field field on bound object.

Throws:

IllegalArgumentException - if the passed Field is not a field on the object bound by this BindingContext

getBindableMethod

public ObjectFieldMethod getBindableMethod(String key)

Looks up an ObjectFieldMethod tuple by its key.

Parameters:

key - - generated by OnChange.call()

Returns:

the tuple for this key (or null, if it doesn't exist)

getBindableModelMethod

public ObjectFieldMethod getBindableModelMethod(String key)

Looks up an ObjectFieldMethod tuple by its key.

Parameters:

key - - generated by OnChange.call()

Returns:

the tuple for this key (or null, if it doesn't exist)

getBindableModel

public BindableModel getBindableModel(String key)

evalOnObject

public Object evalOnObject(String on,
 BindableModel model)

findModelUpdateClass

public static List<Class<?>> findModelUpdateClass(BindableModel modelClass)

Returns the list of ModelUpdate types in this binding context.

Returns:

the of Classes that implement ModelUpdate in this binding context.

findOnObject

public static ModelUpdate findOnObject(String on,
 BindableModel model)

Resolves a string reference, as specified in the on parameter of a Bound annotation to an Enum object in this runtime.

Parameters:

on - on parameter from a Bound annotation.

Returns:

the resolved object

Throws:

IllegalArgumentException - if the referenced object can't be found.

findGetter

public ObjectFieldMethod findGetter(String property)

findSetter

public ObjectFieldMethod findSetter(String property)

getBindableModels

public Set<BindableModel> getBindableModels()

getAnnotatedFields

public List<Field> getAnnotatedFields(Class<? extends Annotation> klass)

getAnnotatedParameterlessMethods

public List<ObjectFieldMethod> getAnnotatedParameterlessMethods(Class<? extends Annotation> annotation)

isOn

public static <T extends Enum<?> & ModelUpdate>
boolean isOn(Object onObject,
 T... changed)

isOn

public static <T extends Enum<?> & ModelUpdate>
boolean isOn(Collection<Object> ons,
 T... changed)

getOnObjects

public static List<Object> getOnObjects(String[] ons,
 BindableModel model)