Package com.sun.xml.bind.v2.runtime.property

Class AttributeProperty<BeanT>

java.lang.Object

com.sun.xml.bind.v2.runtime.property.AttributeProperty<BeanT>

All Implemented Interfaces:

Property<BeanT>, StructureLoaderBuilder, java.lang.Comparable<AttributeProperty>

public final class AttributeProperty<BeanT>
extends java.lang.Object
implements java.lang.Comparable<AttributeProperty>

Property implementation for AttributePropertyInfo.

This one works for both leaves and nodes, scalars and arrays.

Implements Comparable so that it can be sorted lexicographically.

Author:

Kohsuke Kawaguchi (kk@kohsuke.org)

Field Summary

Fields

Modifier and Type	Field	Description
Name	attName	Attribute name.
protected java.lang.String	fieldName	Name of this field.
TransducedAccessor<BeanT>	xacc	Heart of the conversion logic.

Fields inherited from interface com.sun.xml.bind.v2.runtime.property.StructureLoaderBuilder

CATCH_ALL, TEXT_HANDLER

Constructor Summary

Constructors

Constructor	Description
AttributeProperty(JAXBContextImpl context, RuntimeAttributePropertyInfo prop)

Method Summary

Modifier and Type	Method	Description
void	buildChildElementUnmarshallers(UnmarshallerChain chainElem, QNameMap<ChildLoader> handlers)	Every Property class has an implementation of buildChildElementUnmarshallers which will fill in the specified QNameMap by elements that are expected by this property.
int	compareTo(AttributeProperty that)
Accessor	getElementPropertyAccessor(java.lang.String nsUri, java.lang.String localName)	If this property is mapped to the specified element, return an accessor to it.
java.lang.String	getFieldName()
java.lang.String	getIdValue(BeanT bean)	Gets the value of the property.
RuntimePropertyInfo	getInfo()	Provides more RuntimePropertyInfo information on the property.
PropertyKind	getKind()	Gets the Kind of property
boolean	hasSerializeURIAction()	Returns true if Property.serializeURIs(Object,XMLSerializer) performs some meaningful action.
boolean	isHiddenByOverride()
void	reset(BeanT o)	Resets the property value on the given object.
void	serializeAttributes(BeanT o, XMLSerializer w)	Marshals one attribute.
void	serializeBody(BeanT o, XMLSerializer w, java.lang.Object outerPeer)
void	serializeURIs(BeanT o, XMLSerializer w)
void	setHiddenByOverride(boolean hidden)
void	wrapUp()	Called at the end of the JAXBContext initialization phase to clean up any unnecessary references.

Methods inherited from class java.lang.Object

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

Field Detail

attName

public final Name attName

Attribute name.

xacc

public final TransducedAccessor<BeanT> xacc

Heart of the conversion logic.

fieldName

protected final java.lang.String fieldName

Name of this field.

Constructor Detail

AttributeProperty

public AttributeProperty(JAXBContextImpl context,
                         RuntimeAttributePropertyInfo prop)

Method Detail

serializeAttributes

public void serializeAttributes(BeanT o,
                                XMLSerializer w)
                         throws org.xml.sax.SAXException,
                                AccessorException,
                                java.io.IOException,
                                javax.xml.stream.XMLStreamException

Marshals one attribute.

Throws:

org.xml.sax.SAXException

AccessorException

java.io.IOException

javax.xml.stream.XMLStreamException

See Also:

JaxBeanInfo.serializeAttributes(Object, XMLSerializer)

serializeURIs

public void serializeURIs(BeanT o,
                          XMLSerializer w)
                   throws AccessorException,
                          org.xml.sax.SAXException

Specified by:

serializeURIs in interface Property<BeanT>

Throws:

AccessorException

org.xml.sax.SAXException

See Also:

JaxBeanInfo.serializeURIs(Object, XMLSerializer)

hasSerializeURIAction

public boolean hasSerializeURIAction()

Description copied from interface: Property

Returns true if Property.serializeURIs(Object,XMLSerializer) performs some meaningful action.

Specified by:

hasSerializeURIAction in interface Property<BeanT>

buildChildElementUnmarshallers

public void buildChildElementUnmarshallers(UnmarshallerChain chainElem,
                                           QNameMap<ChildLoader> handlers)

Description copied from interface: StructureLoaderBuilder

Every Property class has an implementation of buildChildElementUnmarshallers which will fill in the specified QNameMap by elements that are expected by this property.

Specified by:

buildChildElementUnmarshallers in interface StructureLoaderBuilder

getKind

public PropertyKind getKind()

Description copied from interface: Property

Gets the Kind of property

Specified by:

getKind in interface Property<BeanT>

Returns:

always non-null.

reset

public void reset(BeanT o)
           throws AccessorException

Description copied from interface: Property

Resets the property value on the given object.

... for example by setting 0 or null.

Specified by:

reset in interface Property<BeanT>

Throws:

AccessorException

getIdValue

public java.lang.String getIdValue(BeanT bean)
                            throws AccessorException,
                                   org.xml.sax.SAXException

Description copied from interface: Property

Gets the value of the property. This method is only used when the corresponding PropertyInfo.id() is ID.ID, and therefore the return type is fixed to String.

Specified by:

getIdValue in interface Property<BeanT>

Throws:

AccessorException

org.xml.sax.SAXException

compareTo

public int compareTo(AttributeProperty that)

Specified by:

compareTo in interface java.lang.Comparable<BeanT>

getInfo

public RuntimePropertyInfo getInfo()

Description copied from interface: Property

Provides more RuntimePropertyInfo information on the property.

Specified by:

getInfo in interface Property<BeanT>

Returns:

null if RETAIN_REFERENCE_TO_INFO property is not set on the JAXBContext

serializeBody

public void serializeBody(BeanT o,
                          XMLSerializer w,
                          java.lang.Object outerPeer)
                   throws org.xml.sax.SAXException,
                          AccessorException,
                          java.io.IOException,
                          javax.xml.stream.XMLStreamException

Specified by:

serializeBody in interface Property<BeanT>

outerPeer - used when this property is expected to print out an element and that should be associated with this outer peer. normally null. this is only used for JaxBeanInfo for JAXBElements.

Throws:

AccessorException - If thrown, caught by the caller and reported.

org.xml.sax.SAXException

java.io.IOException

javax.xml.stream.XMLStreamException

See Also:

JaxBeanInfo.serializeBody(Object, XMLSerializer)

getElementPropertyAccessor

public Accessor getElementPropertyAccessor(java.lang.String nsUri,
                                           java.lang.String localName)

Description copied from interface: Property

If this property is mapped to the specified element, return an accessor to it.

Specified by:

getElementPropertyAccessor in interface Property<BeanT>

Returns:

null if the property is not mapped to the specified element.

wrapUp

public void wrapUp()

Description copied from interface: Property

Called at the end of the JAXBContext initialization phase to clean up any unnecessary references.

Specified by:

wrapUp in interface Property<BeanT>

isHiddenByOverride

public boolean isHiddenByOverride()

Specified by:

isHiddenByOverride in interface Property<BeanT>

setHiddenByOverride

public void setHiddenByOverride(boolean hidden)

Specified by:

setHiddenByOverride in interface Property<BeanT>

getFieldName

public java.lang.String getFieldName()

Specified by:

getFieldName in interface Property<BeanT>