Module org.glassfish.jaxb.xjc

Package com.sun.tools.xjc.model

Class CElementPropertyInfo

java.lang.Object

com.sun.tools.xjc.model.CPropertyInfo

com.sun.tools.xjc.model.CElementPropertyInfo

All Implemented Interfaces:

CCustomizable, AnnotationSource, ElementPropertyInfo<com.sun.tools.xjc.model.nav.NType,com.sun.tools.xjc.model.nav.NClass>, PropertyInfo<com.sun.tools.xjc.model.nav.NType,com.sun.tools.xjc.model.nav.NClass>

public final class CElementPropertyInfo
extends CPropertyInfo
implements ElementPropertyInfo<com.sun.tools.xjc.model.nav.NType,com.sun.tools.xjc.model.nav.NClass>

ElementPropertyInfo for the compiler.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CElementPropertyInfo.CollectionMode

Field Summary

Fields inherited from class com.sun.tools.xjc.model.CPropertyInfo

baseType, defaultValue, inlineBinaryData, javadoc, locator, realization

Constructor Summary

Constructors

Constructor	Description
CElementPropertyInfo(String name, CElementPropertyInfo.CollectionMode collection, ID id, javax.activation.MimeType expectedMimeType, XSComponent source, CCustomizations customizations, Locator locator, boolean required)

Method Summary

Modifier and Type	Method	Description
<V> V	accept(CPropertyVisitor<V> visitor)
<R,P> R	accept(CPropertyVisitor2<R,P> visitor, P p)
QName	collectElementNames(Map<QName,CPropertyInfo> table)	Puts the element names that this property possesses to the map, so that we can find two properties that own the same element name, which is an error.
CAdapter	getAdapter()
javax.activation.MimeType	getExpectedMimeType()
QName	getSchemaType()
List<CTypeRef>	getTypes()
QName	getXmlName()	Deprecated.
ID	id()
boolean	isCollectionNillable()
boolean	isCollectionRequired()
boolean	isOptionalPrimitive()	Returns true if this property needs to represent null just for the purpose of representing an absence of the property.
boolean	isRequired()
boolean	isUnboxable()	Returns true if this property is "unboxable".
boolean	isValueList()
PropertyKind	kind()
List<CNonElement>	ref()
void	setAdapter(CAdapter a)

Methods inherited from class com.sun.tools.xjc.model.CPropertyInfo

displayName, getCustomizations, getLocator, getName, getName, getSchemaComponent, hasAnnotation, inlineBinaryData, isCollection, needsExplicitTypeName, parent, readAnnotation, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sun.xml.bind.v2.model.annotation.AnnotationSource

hasAnnotation, readAnnotation

Methods inherited from interface com.sun.xml.bind.v2.model.core.PropertyInfo

displayName, getName, inlineBinaryData, isCollection, parent

Constructor Detail

CElementPropertyInfo

public CElementPropertyInfo(String name,
                            CElementPropertyInfo.CollectionMode collection,
                            ID id,
                            javax.activation.MimeType expectedMimeType,
                            XSComponent source,
                            CCustomizations customizations,
                            Locator locator,
                            boolean required)

Method Detail

id

public ID id()

Specified by:

id in interface PropertyInfo<com.sun.tools.xjc.model.nav.NType,com.sun.tools.xjc.model.nav.NClass>

getTypes

public List<CTypeRef> getTypes()

Specified by:

getTypes in interface ElementPropertyInfo<com.sun.tools.xjc.model.nav.NType,com.sun.tools.xjc.model.nav.NClass>

ref

public List<CNonElement> ref()

Specified by:

ref in interface PropertyInfo<com.sun.tools.xjc.model.nav.NType,com.sun.tools.xjc.model.nav.NClass>

Specified by:

ref in class CPropertyInfo

getSchemaType

public QName getSchemaType()

Specified by:

getSchemaType in interface PropertyInfo<com.sun.tools.xjc.model.nav.NType,com.sun.tools.xjc.model.nav.NClass>

getXmlName

@Deprecated
public QName getXmlName()

Deprecated.

XJC never uses the wrapper element. Always return null.

Specified by:

getXmlName in interface ElementPropertyInfo<com.sun.tools.xjc.model.nav.NType,com.sun.tools.xjc.model.nav.NClass>

isCollectionRequired

public boolean isCollectionRequired()

Specified by:

isCollectionRequired in interface ElementPropertyInfo<com.sun.tools.xjc.model.nav.NType,com.sun.tools.xjc.model.nav.NClass>

isCollectionNillable

public boolean isCollectionNillable()

Specified by:

isCollectionNillable in interface ElementPropertyInfo<com.sun.tools.xjc.model.nav.NType,com.sun.tools.xjc.model.nav.NClass>

isRequired

public boolean isRequired()

Specified by:

isRequired in interface ElementPropertyInfo<com.sun.tools.xjc.model.nav.NType,com.sun.tools.xjc.model.nav.NClass>

isValueList

public boolean isValueList()

Specified by:

isValueList in interface ElementPropertyInfo<com.sun.tools.xjc.model.nav.NType,com.sun.tools.xjc.model.nav.NClass>

isUnboxable

public boolean isUnboxable()

Description copied from class: CPropertyInfo

Returns true if this property is "unboxable".

In general, a property often has to be capable of representing null to indicate the absence of the value. This requires properties to be generated as @XmlElement Float f, not as @XmlElement float f;. But this is slow.

Fortunately, there are cases where we know that the property can never legally be absent. When this condition holds we can generate the optimized "unboxed form".

The exact such conditions depend on the kind of properties, so refer to the implementation code for the details.

This method returns true when the property can be generated as "unboxed form", false otherwise.

When this property is a collection, this method returns true if items in the collection is unboxable. Obviously, the collection itself is always a reference type.

Overrides:

isUnboxable in class CPropertyInfo

isOptionalPrimitive

public boolean isOptionalPrimitive()

Description copied from class: CPropertyInfo

Returns true if this property needs to represent null just for the purpose of representing an absence of the property.

Overrides:

isOptionalPrimitive in class CPropertyInfo

accept

public <V> V accept(CPropertyVisitor<V> visitor)

Specified by:

accept in class CPropertyInfo

accept

public <R,P> R accept(CPropertyVisitor2<R,P> visitor,
                            P p)

Specified by:

accept in class CPropertyInfo

getAdapter

public CAdapter getAdapter()

Specified by:

getAdapter in interface ElementPropertyInfo<com.sun.tools.xjc.model.nav.NType,com.sun.tools.xjc.model.nav.NClass>

Specified by:

getAdapter in interface PropertyInfo<com.sun.tools.xjc.model.nav.NType,com.sun.tools.xjc.model.nav.NClass>

Specified by:

getAdapter in class CPropertyInfo

setAdapter

public void setAdapter(CAdapter a)

kind

public final PropertyKind kind()

Specified by:

kind in interface PropertyInfo<com.sun.tools.xjc.model.nav.NType,com.sun.tools.xjc.model.nav.NClass>

getExpectedMimeType

public javax.activation.MimeType getExpectedMimeType()

Specified by:

getExpectedMimeType in interface PropertyInfo<com.sun.tools.xjc.model.nav.NType,com.sun.tools.xjc.model.nav.NClass>

collectElementNames

public QName collectElementNames(Map<QName,CPropertyInfo> table)

Description copied from class: CPropertyInfo

Puts the element names that this property possesses to the map, so that we can find two properties that own the same element name, which is an error.

Overrides:

collectElementNames in class CPropertyInfo

Returns:

null if no conflict was found. Otherwise return the QName that has the collision.