Package com.inductiveautomation.rm.base

Class RMKey.KeyAccessor

java.lang.Object

com.inductiveautomation.rm.base.RMKey.KeyAccessor

Enclosing class:

RMKey

public static class RMKey.KeyAccessor
extends Object

KeyAccessor - enclosed class for actually getting/setting values for a given object (class) and key.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	RMKey.KeyAccessor.Type

Constructor Summary

Constructors

Constructor	Description
KeyAccessor(Object anObj, String aKey)	Creates a new getter for given object and key (caches type).

Method Summary

Modifier and Type	Method	Description
Object	get(Object anObj)	This method actually retrieves a value for an object and a key.
Method	getGetMethod()	Searches for a get method for given key then caches and returns result.
Method	getSetMethod()	Searches for a set method for given key then caches and returns result.
void	set(Object anObj, Object aValue)	Coerces aValue to this accessor's setter parameter type and invokes that setter on anObj.

Methods inherited from class java.lang.Object

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

Constructor Details

KeyAccessor

public KeyAccessor(Object anObj,
 String aKey)

Creates a new getter for given object and key (caches type).

Method Details

get

public Object get(Object anObj)

This method actually retrieves a value for an object and a key.

getGetMethod

public Method getGetMethod()

Searches for a get method for given key then caches and returns result.

set

public void set(Object anObj,
 Object aValue)
         throws Exception

Coerces aValue to this accessor's setter parameter type and invokes that setter on anObj. Coercion is keyed on the setter's parameter type (the type the setter declares for its argument), not the value's type — so setName(String) stringifies an Integer 42, while setCount(int) parses the String "42". The conversion applied for each parameter type (numeric, String, Number, and Date route through RMUtils; the rest convert inline). The parameter type and how it's coerced is as follows:

• numeric primitives/wrappers — passed through if the value is already that wrapper class (Integer for an int/Integer setter, Long for long, etc.; note a value reaches here boxed, since aValue is an Object), else coerced (e.g. "42" -> 42, 5L -> 5); byte/ short narrow and may wrap
• String — always RMUtils.stringValue(java.lang.Object) (e.g. 42 -> "42")
• other Number subtypes — RMUtils.numberValue(java.lang.Object); Date — RMUtils.getDate(java.lang.Object)
• an enum — only a String value is resolved, by name via Enum.valueOf(java.lang.Class<T>, java.lang.String) (the enum constant itself also works; other types are passed through unchanged)
• Color from RMColor and vice-versa; File from a String path
• any type with no matching rule — passed through unchanged

A List value is treated by the setter's type: a scalar setter receives the list's first element (an empty list is passed as-is), while a List-typed setter receives the whole list. So setName(String) with ["a","b"] stores "a", but setItems(List) stores ["a","b"].

Parameters:

anObj - the object whose setter is invoked

aValue - the value to coerce and set

Throws:

NoSuchMethodException - if no setter can be resolved for this accessor's key

Exception - if the setter throws, or rejects the (uncoerced) value's type

getSetMethod

public Method getSetMethod()
                    throws Exception

Searches for a set method for given key then caches and returns result.

Throws:

Exception