com.sun.xml.bind.v2.runtime.reflect

Class Accessor<BeanT,ValueT>

java.lang.Object

com.sun.xml.bind.v2.runtime.reflect.Accessor<BeanT,ValueT>

All Implemented Interfaces:

Receiver

Direct Known Subclasses:

Accessor.FieldReflection, Accessor.GetterSetterReflection, FieldAccessor_Boolean, FieldAccessor_Byte, FieldAccessor_Character, FieldAccessor_Double, FieldAccessor_Float, FieldAccessor_Integer, FieldAccessor_Long, FieldAccessor_Ref, FieldAccessor_Short, MethodAccessor_Boolean, MethodAccessor_Byte, MethodAccessor_Character, MethodAccessor_Double, MethodAccessor_Float, MethodAccessor_Integer, MethodAccessor_Long, MethodAccessor_Ref, MethodAccessor_Short, NullSafeAccessor

public abstract class Accessor<BeanT,ValueT>
extends Object
implements Receiver

Accesses a particular property of a bean.

This interface encapsulates the access to the actual data store. The intention is to generate implementations for a particular bean and a property to improve the performance.

Accessor can be used as a receiver. Upon receiving an object it sets that to the field.

Author:

Kohsuke Kawaguchi (kk@kohsuke.org)

See Also:

Accessor.FieldReflection, TransducedAccessor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Accessor.FieldReflection<BeanT,ValueT> Accessor that uses Java reflection to access a field.
static class	Accessor.GetterOnlyReflection<BeanT,ValueT> A version of Accessor.GetterSetterReflection that doesn't have any setter.
static class	Accessor.GetterSetterReflection<BeanT,ValueT> Accessor that uses Java reflection to access a getter and a setter.
static class	Accessor.ReadOnlyFieldReflection<BeanT,ValueT> Read-only access to Field.
static class	Accessor.SetterOnlyReflection<BeanT,ValueT> A version of Accessor.GetterSetterReflection thaat doesn't have any getter.

Field Summary

Fields

Modifier and Type	Field and Description
static Accessor<JAXBElement,Object>	JAXB_ELEMENT_VALUE Accessor for JAXBElement.getValue().
Class<ValueT>	valueType

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Accessor(Class<ValueT> valueType)

Method Summary

Modifier and Type	Method and Description
<T> Accessor<BeanT,T>	adapt(Adapter<Type,Class> adapter)
<T> Accessor<BeanT,T>	adapt(Class<T> targetType, Class<? extends XmlAdapter<T,ValueT>> adapter) Wraps this Accessor into another Accessor and performs the type adaption as necessary.
abstract ValueT	get(BeanT bean) Gets the value of the property of the given bean object.
static <A,B> Accessor<A,B>	getErrorInstance() Gets the special Accessor used to recover from errors.
Object	getUnadapted(BeanT bean) Sets the value without adapting the value.
Class<ValueT>	getValueType()
boolean	isAbstractable(Class clazz) Checks if it is not builtin jaxb class
boolean	isAdapted() Returns true if this accessor wraps an adapter.
boolean	isValueTypeAbstractable()
Accessor<BeanT,ValueT>	optimize(JAXBContextImpl context) Returns the optimized version of the same accessor.
void	receive(UnmarshallingContext.State state, Object o) Called when the child loader is deactivated.
abstract void	set(BeanT bean, ValueT value) Sets the value of the property of the given bean object.
void	setUnadapted(BeanT bean, Object value) Sets the value without adapting the value.

Methods inherited from class java.lang.Object

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

Field Detail

valueType

public final Class<ValueT> valueType

JAXB_ELEMENT_VALUE

public static final Accessor<JAXBElement,Object> JAXB_ELEMENT_VALUE

Accessor for JAXBElement.getValue().

Constructor Detail

Accessor

protected Accessor(Class<ValueT> valueType)

Method Detail

getValueType

public Class<ValueT> getValueType()

optimize

public Accessor<BeanT,ValueT> optimize(@Nullable
                                       JAXBContextImpl context)

Returns the optimized version of the same accessor.

Parameters:

context - The JAXBContextImpl that owns the whole thing. (See RuntimeModelBuilder.context.)

Returns:

At least the implementation can return this.

get

public abstract ValueT get(BeanT bean)
                    throws AccessorException

Gets the value of the property of the given bean object.

Parameters:

bean - must not be null.

Throws:

AccessorException - if failed to set a value. For example, the getter method may throw an exception.

Since:

2.0 EA1

set

public abstract void set(BeanT bean,
                         ValueT value)
                  throws AccessorException

Sets the value of the property of the given bean object.

Parameters:

bean - must not be null.

value - the value to be set. Setting value to null means resetting to the VM default value (even for primitive properties.)

Throws:

AccessorException - if failed to set a value. For example, the setter method may throw an exception.

Since:

2.0 EA1

getUnadapted

public Object getUnadapted(BeanT bean)
                    throws AccessorException

Sets the value without adapting the value.

This ugly entry point is only used by JAX-WS. See JAXBRIContext.getElementPropertyAccessor(java.lang.Class<B>, java.lang.String, java.lang.String)

Throws:

AccessorException

isAdapted

public boolean isAdapted()

Returns true if this accessor wraps an adapter.

This method needs to be used with care, but it helps some optimization.

setUnadapted

public void setUnadapted(BeanT bean,
                         Object value)
                  throws AccessorException

Sets the value without adapting the value.

This ugly entry point is only used by JAX-WS. See JAXBRIContext.getElementPropertyAccessor(java.lang.Class<B>, java.lang.String, java.lang.String)

Throws:

AccessorException

receive

public void receive(UnmarshallingContext.State state,
                    Object o)
             throws SAXException

Description copied from interface: Receiver

Called when the child loader is deactivated.

Specified by:

receive in interface Receiver

Parameters:

state - points to the parent's current state.

o - object that was loaded. may be null.

Throws:

SAXException

isValueTypeAbstractable

public boolean isValueTypeAbstractable()

isAbstractable

public boolean isAbstractable(Class clazz)

Checks if it is not builtin jaxb class

Parameters:

clazz - to be checked

Returns:

true if it is NOT builtin class

adapt

public final <T> Accessor<BeanT,T> adapt(Class<T> targetType,
                                         Class<? extends XmlAdapter<T,ValueT>> adapter)

Wraps this Accessor into another Accessor and performs the type adaption as necessary.

adapt

public final <T> Accessor<BeanT,T> adapt(Adapter<Type,Class> adapter)

getErrorInstance

public static <A,B> Accessor<A,B> getErrorInstance()

Gets the special Accessor used to recover from errors.