|
EclipseLink 2.3.2, build 'v20111125-r10461' API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.persistence.jaxb.compiler.Property
public class Property
INTERNAL:
Purpose:To store information about a property on a class during JAXB 2.0 Generation
Responsibilities:
This class is used to store information about a property on a JAXB 2.0 annotated class. It is created by the AnnotationsProcessor during pre-processing and stored on a TypeInfo object
TypeInfo
,
AnnotationsProcessor
Field Summary | |
---|---|
static java.lang.String |
DEFAULT_KEY_NAME
|
static java.lang.String |
DEFAULT_VALUE_NAME
|
Constructor Summary | |
---|---|
Property()
|
|
Property(Helper helper)
|
Method Summary | |
---|---|
void |
addReferencedElement(ElementDeclaration element)
Add an ElementDeclaration to the list of referenced elements. |
java.lang.Object |
clone()
Return a shallow copy of this Property. |
JavaClass |
getActualType()
Return the generic type if it was set (collection or array item type) otherwise return the type of this property |
java.util.Collection<Property> |
getChoiceProperties()
Return the choice properties set on this property. |
java.lang.String |
getDefaultValue()
|
java.lang.String |
getDomHandlerClassName()
Return the DomHandler class name. |
JavaHasAnnotations |
getElement()
|
java.lang.String |
getFixedValue()
|
JavaClass |
getGenericType()
|
java.lang.String |
getGetMethodName()
|
JavaClass |
getInverseReferencePropertyContainerClass()
|
java.lang.String |
getInverseReferencePropertyGetMethodName()
|
java.lang.String |
getInverseReferencePropertyName()
|
java.lang.String |
getInverseReferencePropertySetMethodName()
|
JavaClass |
getKeyType()
|
java.lang.String |
getMimeType()
|
XmlAbstractNullPolicy |
getNullPolicy()
Returns the null policy for this property. |
java.lang.String |
getOriginalGetMethodName()
|
java.lang.String |
getOriginalSetMethodName()
|
JavaClass |
getOriginalType()
Get the original type of the property. |
java.lang.String |
getPropertyName()
|
java.util.List<ElementDeclaration> |
getReferencedElements()
Return the list of referenced elements. |
javax.xml.namespace.QName |
getSchemaName()
|
javax.xml.namespace.QName |
getSchemaType()
|
java.lang.String |
getSetMethodName()
|
JavaClass |
getType()
|
java.util.Map<java.lang.Object,java.lang.Object> |
getUserProperties()
Return the Map of user-defined properties. |
JavaClass |
getValueType()
|
java.util.List<XmlElementRef> |
getXmlElementRefs()
Return the List of XmlElementRef(s) for this Property. |
XmlElements |
getXmlElements()
Return the XmlElements object set for this Property. |
XmlElementWrapper |
getXmlElementWrapper()
Return the XmlElementWrapper set on this property. |
XmlJavaTypeAdapter |
getXmlJavaTypeAdapter()
Return the xmlJavaTypeAdapter set on this Property. |
XmlJoinNodes |
getXmlJoinNodes()
Return the XmlJoinNodes for this property. |
java.util.List<XmlJoinNodes> |
getXmlJoinNodesList()
Return the list of XmlJoinNodes for this Property, if any. |
java.lang.String |
getXmlPath()
Return the xpath for this property. |
XmlTransformation |
getXmlTransformation()
Return the XmlTransformation set on this property. |
boolean |
isAny()
Returns indicator for XmlAnyElement |
boolean |
isAnyAttribute()
|
boolean |
isAttribute()
|
boolean |
isCdata()
|
boolean |
isChoice()
Indicates if this property represents a choice property. |
boolean |
isCollectionType(JavaClass type)
|
boolean |
isInlineBinaryData()
Indicates if XOP encoding should be disabled for datatypes that are bound to base64-encoded binary data in XML. |
boolean |
isInverseReference()
|
boolean |
isLax()
Used with XmlAnyElement. |
boolean |
isMap()
|
boolean |
isMethodProperty()
|
boolean |
isMixedContent()
|
boolean |
isMtomAttachment()
|
boolean |
isNillable()
|
boolean |
isPositional()
Indicates if this property is mapped by position, i.e. name="data[1]" |
boolean |
isReadOnly()
Indicates if the mapping for this Property is read-only. |
boolean |
isReference()
Indicates if this Property is a reference property. |
boolean |
isRequired()
|
boolean |
isSetCdata()
Indicates if the isCdata flag was set via external metadata. |
boolean |
isSetDefaultValue()
|
boolean |
isSetNullPolicy()
Indicates if a null policy is set for this property. |
boolean |
isSetReadOnly()
Indicates if the isReadOnly flag was set via external metadata. |
boolean |
isSetUserProperties()
Indicates if a map of userProperties is set for this property. |
boolean |
isSetWriteOnly()
Indicates if the isWriteOnly flag was set via external metadata. |
boolean |
isSetXmlElementWrapper()
Indicates if an XmlElementWrapper has been set, i.e. the xmlElementWrapper property is non-null. |
boolean |
isSetXmlJavaTypeAdapter()
Indicates if an XmlJavaTypeAdapter has been set, i.e. the xmlJavaTypeAdapter property is non-null. |
boolean |
isSetXmlJoinNodes()
Indicates if this property has XmlJoinNodes set. |
boolean |
isSetXmlJoinNodesList()
Indicates if xmlJoinNodesList has been set, i.e. is non-null |
boolean |
isSetXmlPath()
Indicates if an xpath is set for this property. |
boolean |
isSetXmlTransformation()
Indicates if an XmlTransformation is set for this porperty. |
boolean |
isSwaAttachmentRef()
|
boolean |
isTransient()
|
boolean |
isVirtual()
|
boolean |
isWriteOnly()
|
boolean |
isXmlElementType()
|
boolean |
isXmlId()
Indicates if this property is an ID field. |
boolean |
isXmlIdRef()
Indicates if this property is a reference to an ID field. |
boolean |
isXmlList()
Indicates if this property is an XmlList. |
boolean |
isXmlTransformation()
Indicates if this property represents an XmlTransformation. |
boolean |
isXmlValue()
Indicates if this property is an XmlValue. |
void |
setAdapterClass(JavaClass adapterCls)
Set an XmlAdapter on this Property. |
void |
setCdata(boolean isCdata)
Flag the mapping for this Property as containing character data. |
void |
setChoice(boolean choice)
Set flag to indicate whether this property represents a choice property. |
void |
setChoiceProperties(java.util.Collection<Property> properties)
Set the choice properties for this property. |
void |
setDefaultValue(java.lang.String defaultValue)
|
void |
setDomHandlerClassName(java.lang.String domHandlerClassName)
Set the DomHandler class name. |
void |
setElement(JavaHasAnnotations element)
|
void |
setExtension(boolean value)
|
void |
setFixedValue(java.lang.String fixedValue)
|
void |
setGenericType(JavaClass genericType)
|
void |
setGetMethodName(java.lang.String methodName)
|
void |
setHasXmlElementType(boolean hasXmlElementType)
|
void |
setHelper(Helper helper)
|
void |
setInverseReference(boolean isInverseReference)
|
void |
setInverseReferencePropertyContainerClass(JavaClass cls)
|
void |
setInverseReferencePropertyGetMethodName(java.lang.String methodName)
|
void |
setInverseReferencePropertyName(java.lang.String name)
|
void |
setInverseReferencePropertySetMethodName(java.lang.String methodName)
|
void |
setIsAny(boolean isAnyElement)
Set indicator for XmlAnyElement. |
void |
setIsAnyAttribute(boolean anyAtribute)
|
void |
setIsAttribute(boolean attribute)
|
void |
setisInlineBinaryData(boolean b)
Sets the flag that indicates if XOP encoding should be disabled for datatypes that are bound to base64-encoded binary data in XML. |
void |
setIsMtomAttachment(boolean b)
|
void |
setIsReference(boolean isReference)
Set flag to indicate whether this property represents a reference property. |
void |
setIsRequired(boolean b)
|
void |
setIsSwaAttachmentRef(boolean b)
|
void |
setIsXmlId(boolean isXmlId)
Sets the indicator that identifies this property as an ID field. |
void |
setIsXmlIdRef(boolean isXmlIdRef)
Sets the indicator that identifies this property as a reference to an ID field. |
void |
setIsXmlList(boolean isXmlList)
Set the isXmlList property. |
void |
setIsXmlTransformation(boolean isXmlTransformation)
Set flag that indicates if this property represents an XmlTransformation. |
void |
setIsXmlValue(boolean isXmlValue)
Set the isXmlValue property. |
void |
setKeyType(JavaClass keyType)
|
void |
setLax(boolean b)
Used with XmlAnyElement. |
void |
setMethodProperty(boolean isMethod)
|
void |
setMimeType(java.lang.String mType)
|
void |
setMixedContent(boolean b)
|
void |
setNillable(boolean isNillable)
|
void |
setNullPolicy(XmlAbstractNullPolicy nullPolicy)
Set the null policy for this property. |
void |
setOriginalGetMethodName(java.lang.String methodName)
|
void |
setOriginalSetMethodName(java.lang.String methodName)
|
void |
setOriginalType(JavaClass type)
Set the original type of the property. |
void |
setPropertyName(java.lang.String propertyName)
|
void |
setReadOnly(boolean isReadOnly)
Flag the mapping for this Property as read-only. |
void |
setSchemaName(javax.xml.namespace.QName schemaName)
|
void |
setSchemaType(javax.xml.namespace.QName type)
|
void |
setSetMethodName(java.lang.String methodName)
|
void |
setTransient(boolean isTransient)
|
void |
setType(JavaClass cls)
|
void |
setUserProperties(java.util.Map<java.lang.Object,java.lang.Object> userProperties)
Set the Map of user-defined properties. |
void |
setValueType(JavaClass valueType)
|
void |
setWriteOnly(boolean isWriteOnly)
Flag the mapping for this Property as write-only. |
void |
setXmlElementRefs(java.util.List<XmlElementRef> xmlElementRefs)
Set the List of XmlElementRef(s) for this Property. |
void |
setXmlElements(XmlElements xmlElements)
Set the XmlElements object for this Property. |
void |
setXmlElementWrapper(XmlElementWrapper xmlElementWrapper)
Set the XmlElementWrapper for this property. |
void |
setXmlJavaTypeAdapter(XmlJavaTypeAdapter xmlJavaTypeAdapter)
Set an XmlJavaTypeAdapter on this Property. |
void |
setXmlJoinNodes(XmlJoinNodes xmlJoinNodes)
Set XmlJoinNodes for this property. |
void |
setXmlJoinNodesList(java.util.List<XmlJoinNodes> xmlJoinNodesList)
Set the list of XmlJoinNodes for this Property. |
void |
setXmlPath(java.lang.String xmlPath)
Set the xpath for this property. |
void |
setXmlTransformation(XmlTransformation xmlTransformation)
Set the XmlTransformation for this property. |
boolean |
shouldSetNillable()
Indicates if nillable='true' should be set on a given schema component. |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String DEFAULT_KEY_NAME
public static final java.lang.String DEFAULT_VALUE_NAME
Constructor Detail |
---|
public Property()
public Property(Helper helper)
Method Detail |
---|
public void setHelper(Helper helper)
public void setAdapterClass(JavaClass adapterCls)
adapterCls
- public JavaHasAnnotations getElement()
public void setElement(JavaHasAnnotations element)
public java.lang.String getPropertyName()
public void setPropertyName(java.lang.String propertyName)
public javax.xml.namespace.QName getSchemaName()
public void setSchemaName(javax.xml.namespace.QName schemaName)
public boolean isMethodProperty()
public void setMethodProperty(boolean isMethod)
public void setType(JavaClass cls)
public JavaClass getType()
public JavaClass getGenericType()
public void setGenericType(JavaClass genericType)
public javax.xml.namespace.QName getSchemaType()
public void setSchemaType(javax.xml.namespace.QName type)
public boolean isSwaAttachmentRef()
public void setIsSwaAttachmentRef(boolean b)
public boolean isMtomAttachment()
public void setIsMtomAttachment(boolean b)
public boolean isInlineBinaryData()
public void setisInlineBinaryData(boolean b)
b
- if true, XOP encoding will be disabled for datatypes
that are bound to base64-encoded binary data in XML.public boolean isRequired()
public void setIsRequired(boolean b)
public java.lang.String getMimeType()
public void setMimeType(java.lang.String mType)
public boolean isAttribute()
public boolean isAnyAttribute()
public void setIsAttribute(boolean attribute)
public void setIsAnyAttribute(boolean anyAtribute)
public java.lang.String getGetMethodName()
public void setGetMethodName(java.lang.String methodName)
public java.lang.String getSetMethodName()
public void setSetMethodName(java.lang.String methodName)
public java.lang.String getOriginalGetMethodName()
public void setOriginalGetMethodName(java.lang.String methodName)
public java.lang.String getOriginalSetMethodName()
public void setOriginalSetMethodName(java.lang.String methodName)
public boolean isChoice()
public void setChoice(boolean choice)
choice
- public boolean isAny()
public void setIsAny(boolean isAnyElement)
isAnyElement
- public boolean isReference()
public void setIsReference(boolean isReference)
isReference
- public boolean isNillable()
public void setNillable(boolean isNillable)
public boolean isTransient()
public void setTransient(boolean isTransient)
public void setDefaultValue(java.lang.String defaultValue)
defaultValue
- the defaultValue to setpublic java.lang.String getDefaultValue()
public boolean isSetDefaultValue()
public boolean isMixedContent()
public void setMixedContent(boolean b)
public void setHasXmlElementType(boolean hasXmlElementType)
public boolean isXmlElementType()
public boolean isCollectionType(JavaClass type)
public JavaClass getActualType()
public JavaClass getOriginalType()
public void setOriginalType(JavaClass type)
public boolean isSetXmlJavaTypeAdapter()
XmlJavaTypeAdapter
public XmlJavaTypeAdapter getXmlJavaTypeAdapter()
XmlJavaTypeAdapter
public void setXmlJavaTypeAdapter(XmlJavaTypeAdapter xmlJavaTypeAdapter)
xmlJavaTypeAdapter
- XmlJavaTypeAdapter
public boolean isSetXmlElementWrapper()
public XmlElementWrapper getXmlElementWrapper()
public void setXmlElementWrapper(XmlElementWrapper xmlElementWrapper)
xmlElementWrapper
- public void setIsXmlValue(boolean isXmlValue)
isXmlValue
- public boolean isXmlValue()
public void setIsXmlList(boolean isXmlList)
isXmlList
- public boolean isXmlList()
public java.lang.String getInverseReferencePropertyName()
public void setInverseReferencePropertyName(java.lang.String name)
public java.lang.String getInverseReferencePropertyGetMethodName()
public java.lang.String getInverseReferencePropertySetMethodName()
public void setInverseReferencePropertyGetMethodName(java.lang.String methodName)
public void setInverseReferencePropertySetMethodName(java.lang.String methodName)
public JavaClass getInverseReferencePropertyContainerClass()
public void setInverseReferencePropertyContainerClass(JavaClass cls)
public boolean isXmlId()
public void setIsXmlId(boolean isXmlId)
isXmlIdRef
- public boolean isXmlIdRef()
public void setIsXmlIdRef(boolean isXmlIdRef)
isXmlIdRef
- public boolean isLax()
public void setLax(boolean b)
b
- public java.lang.String getDomHandlerClassName()
public void setDomHandlerClassName(java.lang.String domHandlerClassName)
domHandlerClassName
- public JavaClass getKeyType()
public void setKeyType(JavaClass keyType)
public JavaClass getValueType()
public void setValueType(JavaClass valueType)
public boolean isMap()
public boolean isInverseReference()
public void setInverseReference(boolean isInverseReference)
public XmlElements getXmlElements()
public void setXmlElements(XmlElements xmlElements)
xmlElements
- public java.util.Collection<Property> getChoiceProperties()
public void setChoiceProperties(java.util.Collection<Property> properties)
properties
- public java.util.List<XmlElementRef> getXmlElementRefs()
public void setXmlElementRefs(java.util.List<XmlElementRef> xmlElementRefs)
xmlElementRefs
- public void addReferencedElement(ElementDeclaration element)
element
- public java.util.List<ElementDeclaration> getReferencedElements()
public java.lang.String getFixedValue()
public void setFixedValue(java.lang.String fixedValue)
public boolean isPositional()
public void setReadOnly(boolean isReadOnly)
isReadOnly
- the true/false value to setpublic boolean isReadOnly()
public boolean isSetReadOnly()
public void setWriteOnly(boolean isWriteOnly)
isWriteOnly
- the true/false value to setpublic boolean isWriteOnly()
public boolean isSetWriteOnly()
public void setCdata(boolean isCdata)
isCdata
- the true/false value to setpublic boolean isCdata()
public boolean isSetCdata()
public java.lang.String getXmlPath()
public void setXmlPath(java.lang.String xmlPath)
xmlPath
- public boolean isSetXmlPath()
public XmlAbstractNullPolicy getNullPolicy()
public void setNullPolicy(XmlAbstractNullPolicy nullPolicy)
nullPolicy
- public boolean isSetNullPolicy()
public boolean shouldSetNillable()
public java.util.Map<java.lang.Object,java.lang.Object> getUserProperties()
public void setUserProperties(java.util.Map<java.lang.Object,java.lang.Object> userProperties)
userProperties
- public boolean isSetUserProperties()
public XmlTransformation getXmlTransformation()
public void setXmlTransformation(XmlTransformation xmlTransformation)
xmlTransformation
- public boolean isSetXmlTransformation()
public boolean isXmlTransformation()
public void setIsXmlTransformation(boolean isXmlTransformation)
isXmlTransformation
- public void setXmlJoinNodes(XmlJoinNodes xmlJoinNodes)
xmlJoinNodes
- the xmlJoinNodes to setpublic XmlJoinNodes getXmlJoinNodes()
public boolean isSetXmlJoinNodes()
public java.lang.Object clone()
clone
in class java.lang.Object
public java.util.List<XmlJoinNodes> getXmlJoinNodesList()
public void setXmlJoinNodesList(java.util.List<XmlJoinNodes> xmlJoinNodesList)
public boolean isSetXmlJoinNodesList()
public boolean isVirtual()
public void setExtension(boolean value)
|
EclipseLink 2.3.2, build 'v20111125-r10461' API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |