com.sun.tools.xjc.model
Class CElementInfo

java.lang.Object
  com.sun.tools.xjc.model.CElementInfo

All Implemented Interfaces:

CClassInfoParent, CCustomizable, CElement, CTypeInfo, NType, Locatable, Element<NType,NClass>, ElementInfo<NType,NClass>, TypeInfo<NType,NClass>

public final class CElementInfo
extends java.lang.Object
implements ElementInfo<NType,NClass>, NType, CClassInfoParent

ElementInfo implementation for the compile-time model.

As an NType, it represents the Java representation of this element (either JAXBElement<T> or Foo).

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested classes/interfaces inherited from interface com.sun.tools.xjc.model.CClassInfoParent

CClassInfoParent.Package, CClassInfoParent.Visitor<T>

Field Summary

CClassInfoParent

parent If this element is global, the element info is considered to be package-level, and this points to the package in which this element lives in.

Constructor Summary

CElementInfo(Model model, javax.xml.namespace.QName tagName, CClassInfoParent parent, java.lang.String className, CCustomizations customizations, org.xml.sax.Locator location)
Creates an element with a class in the given parent.

CElementInfo(Model model, javax.xml.namespace.QName tagName, CClassInfoParent parent, TypeUse contentType, XmlString defaultValue, XSElementDecl source, CCustomizations customizations, org.xml.sax.Locator location)
Creates an element in the given parent.

Method Summary

JPackage	_package()
<T> T	accept(CClassInfoParent.Visitor<T> visitor)
boolean	canBeReferencedByIDREF() Deprecated. why are you calling an unimplemented method?
JExpression	createConstant(Outline outline, XmlString lexical)
java.lang.String	fullName() Human readable name of this type.
CAdapter	getAdapterUse()
NType	getContentInMemoryType() T of JAXBElement<T>.
CNonElement	getContentType() Short for getProperty().ref().get(0).
CCustomizations	getCustomizations() Gets the list of customizations attached to this model component.
java.lang.String	getDefaultValue()
javax.xml.namespace.QName	getElementName() Gets the element name of the class.
javax.activation.MimeType	getExpectedMimeType() No default MimeType.
Location	getLocation() Gets the location object that this object points to.
org.xml.sax.Locator	getLocator() Gets the source location in the schema from which this model component is created.
JPackage	getOwnerPackage() Gets the nearest JPackage.
CElementPropertyInfo	getProperty() Gets the object that represents the value property.
XSComponent	getSchemaComponent() If this model object is built from XML Schema, this property returns a schema component from which the model is built.
CClassInfo	getScope() If non-null, this element is only active inside the given scope.
java.lang.String	getSqueezedName() Returns the "squeezed name" of this element.
CElementInfo	getSubstitutionHead() If this element can substitute another element, return that element.
java.util.Collection<CElementInfo>	getSubstitutionMembers() All the ElementInfos whose ElementInfo.getSubstitutionHead() points to this object.
NType	getType() Deprecated. why are you calling a method that returns this?
Locatable	getUpstream() Gets the upstream Location information.
boolean	hasClass() True if this element has its own class (as opposed to be represented as an instance of JAXBElement.
ID	idUse()
void	initContentType(TypeUse contentType, XSElementDecl source, XmlString defaultValue)
boolean	isAbstract() Returns true iff this element is an abstract element.
boolean	isBoxedType() Returns true iff this type represents a class that has a unboxed form.
boolean	isCollection()
void	setAbstract() Marks this element as an abstract element.
void	setSubstitutionHead(CElementInfo substitutionHead)
java.lang.String	shortName()
JType	toType(Outline o, Aspect aspect) Returns the representation of this type in code model.

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.core.TypeInfo

canBeReferencedByIDREF

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

getLocation, getUpstream

Methods inherited from interface com.sun.tools.xjc.model.CCustomizable

getCustomizations, getSchemaComponent

Field Detail

parent

public final CClassInfoParent parent

If this element is global, the element info is considered to be package-level, and this points to the package in which this element lives in.

For local elements, this points to the parent CClassInfo.

Constructor Detail

CElementInfo

public CElementInfo(Model model,
                    javax.xml.namespace.QName tagName,
                    CClassInfoParent parent,
                    TypeUse contentType,
                    XmlString defaultValue,
                    XSElementDecl source,
                    CCustomizations customizations,
                    org.xml.sax.Locator location)

Creates an element in the given parent.

When using this construction, initContentType(TypeUse, XSElementDecl, XmlString) must not be invoked.

CElementInfo

public CElementInfo(Model model,
                    javax.xml.namespace.QName tagName,
                    CClassInfoParent parent,
                    java.lang.String className,
                    CCustomizations customizations,
                    org.xml.sax.Locator location)

Creates an element with a class in the given parent.

When using this construction, the caller must use initContentType(TypeUse, XSElementDecl, XmlString) to fill in the content type later. This is to avoid a circular model construction dependency between buidling a type inside an element and element itself. To build a content type, you need to have CElementInfo for a parent, so we can't take it as a constructor parameter.

Method Detail

initContentType

public void initContentType(TypeUse contentType,
                            @Nullable
                            XSElementDecl source,
                            XmlString defaultValue)

getDefaultValue

public final java.lang.String getDefaultValue()

_package

public final JPackage _package()

getContentType

public CNonElement getContentType()

Description copied from interface: ElementInfo

Short for getProperty().ref().get(0). The type of the value this element holds. Normally, this is the T of JAXBElement<T>. But if the property is adapted, this is the on-the-wire type. Or if the element has a list of values, then this field represents the type of the individual item.

Specified by:

getContentType in interface ElementInfo<NType,NClass>

See Also:

ElementInfo.getContentInMemoryType()

getContentInMemoryType

public NType getContentInMemoryType()

Description copied from interface: ElementInfo

T of JAXBElement<T>.

This is tied to the in-memory representation.

Specified by:

getContentInMemoryType in interface ElementInfo<NType,NClass>

See Also:

ElementInfo.getContentType()

getProperty

public CElementPropertyInfo getProperty()

Description copied from interface: ElementInfo

Gets the object that represents the value property.

Specified by:

getProperty in interface ElementInfo<NType,NClass>

Returns:

non-null.

getScope

public CClassInfo getScope()

Description copied from interface: Element

If non-null, this element is only active inside the given scope.

Specified by:

getScope in interface Element<NType,NClass>

getType

public NType getType()

Deprecated. why are you calling a method that returns this?

Description copied from interface: ElementInfo

Returns the representation for JAXBElement<contentInMemoryType>.

This returns the signature in Java and thus isn't affected by the adapter.

Specified by:

getType in interface ElementInfo<NType,NClass>

Specified by:

getType in interface TypeInfo<NType,NClass>

Returns:

always non-null.

getElementName

public javax.xml.namespace.QName getElementName()

Description copied from interface: Element

Gets the element name of the class.

Specified by:

getElementName in interface Element<NType,NClass>

Returns:

Always non-null.

toType

public JType toType(Outline o,
                    Aspect aspect)

Description copied from interface: NType

Returns the representation of this type in code model.

This operation requires the whole model to be built, and hence it takes Outline.

Under some code generation strategy, some bean classes are considered implementation specific (such as impl.FooImpl class) These classes always have accompanying "exposed" type (such as the Foo interface).

For such Jekyll and Hyde type, the aspect parameter determines which personality is returned.

Specified by:

toType in interface CTypeInfo

Specified by:

toType in interface NType

aspect - If Aspect.IMPLEMENTATION, this method returns the implementation specific class that this type represents. If Aspect.EXPOSED, this method returns the publicly exposed type that this type represents. For ordinary classes, the aspect parameter is meaningless.

See Also:

NType.toType(Outline, Aspect)

getSqueezedName

public java.lang.String getSqueezedName()

Returns the "squeezed name" of this element.

See Also:

CClassInfo.getSqueezedName()

getSubstitutionHead

public CElementInfo getSubstitutionHead()

Description copied from interface: Element

If this element can substitute another element, return that element.

Substitutability of elements are transitive.

Specified by:

getSubstitutionHead in interface Element<NType,NClass>

Specified by:

getSubstitutionHead in interface ElementInfo<NType,NClass>

Returns:

null if no such element exists.

getSubstitutionMembers

public java.util.Collection<CElementInfo> getSubstitutionMembers()

Description copied from interface: ElementInfo

All the ElementInfos whose ElementInfo.getSubstitutionHead() points to this object.

Specified by:

getSubstitutionMembers in interface ElementInfo<NType,NClass>

Returns:

can be empty but never null.

setSubstitutionHead

public void setSubstitutionHead(CElementInfo substitutionHead)

isBoxedType

public boolean isBoxedType()

Description copied from interface: NType

Returns true iff this type represents a class that has a unboxed form. For example, for String this is false, but for Integer this is true.

Specified by:

isBoxedType in interface NType

fullName

public java.lang.String fullName()

Description copied from interface: NType

Human readable name of this type.

Specified by:

fullName in interface CClassInfoParent

Specified by:

fullName in interface NType

accept

public <T> T accept(CClassInfoParent.Visitor<T> visitor)

Specified by:

accept in interface CClassInfoParent

getOwnerPackage

public JPackage getOwnerPackage()

Description copied from interface: CClassInfoParent

Gets the nearest JPackage.

Specified by:

getOwnerPackage in interface CClassInfoParent

shortName

public java.lang.String shortName()

hasClass

public boolean hasClass()

True if this element has its own class (as opposed to be represented as an instance of JAXBElement.

getLocator

public org.xml.sax.Locator getLocator()

Description copied from interface: CCustomizable

Gets the source location in the schema from which this model component is created.

Specified by:

getLocator in interface CCustomizable

Returns:

never null.

isAbstract

public boolean isAbstract()

Description copied from interface: CElement

Returns true iff this element is an abstract element.

Specified by:

isAbstract in interface CElement

setAbstract

public void setAbstract()

Description copied from interface: CElement

Marks this element as an abstract element.

Specified by:

setAbstract in interface CElement

isCollection

public final boolean isCollection()

getAdapterUse

public final CAdapter getAdapterUse()

idUse

public final ID idUse()

getSchemaComponent

public final XSComponent getSchemaComponent()

Description copied from interface: CCustomizable

If this model object is built from XML Schema, this property returns a schema component from which the model is built.

Specified by:

getSchemaComponent in interface CCustomizable

Returns:

null if the model is built from sources other than XML Schema (such as DTD.)

canBeReferencedByIDREF

public final boolean canBeReferencedByIDREF()

Deprecated. why are you calling an unimplemented method?

Description copied from interface: TypeInfo

True if this type is a valid target from a property annotated with XmlIDREF.

Specified by:

canBeReferencedByIDREF in interface TypeInfo<NType,NClass>

getExpectedMimeType

public javax.activation.MimeType getExpectedMimeType()

No default MimeType.

getCustomizations

public CCustomizations getCustomizations()

Description copied from interface: CCustomizable

Gets the list of customizations attached to this model component.

Specified by:

getCustomizations in interface CCustomizable

Returns:

can be an empty list but never be null. The returned list is read-only. Do not modify.

See Also:

Plugin.getCustomizationURIs()

createConstant

public JExpression createConstant(Outline outline,
                                  XmlString lexical)

getUpstream

public final Locatable getUpstream()

Description copied from interface: Locatable

Gets the upstream Location information.

Specified by:

getUpstream in interface Locatable

Returns:

can be null.

getLocation

public final Location getLocation()

Description copied from interface: Locatable

Gets the location object that this object points to. This operation could be inefficient and costly.

Specified by:

getLocation in interface Locatable