Package com.sun.tools.xjc.model

Class CClassInfo

java.lang.Object

com.sun.tools.xjc.model.CClassInfo

All Implemented Interfaces:

CClass, CClassInfoParent, CCustomizable, CElement, CNonElement, CTypeInfo, NClass, NType, TypeUse, com.sun.xml.bind.v2.model.annotation.Locatable, com.sun.xml.bind.v2.model.core.ClassInfo<NType,NClass>, com.sun.xml.bind.v2.model.core.Element<NType,NClass>, com.sun.xml.bind.v2.model.core.MaybeElement<NType,NClass>, com.sun.xml.bind.v2.model.core.NonElement<NType,NClass>, com.sun.xml.bind.v2.model.core.TypeInfo<NType,NClass>

public final class CClassInfo
extends java.lang.Object
implements com.sun.xml.bind.v2.model.core.ClassInfo<NType,NClass>, CClassInfoParent, CClass, NClass

Mutable ClassInfo representation.

Schema parsers build these objects.

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

Fields

Modifier and Type	Field	Description
java.lang.String	javadoc	TODO: revisit this design.
Model	model	The Model object to which this bean belongs.
java.lang.String	shortName	short name.

Fields inherited from interface com.sun.xml.bind.v2.model.core.NonElement

ANYTYPE_NAME

Constructor Summary

Constructors

Constructor	Description
CClassInfo(Model model, JCodeModel cm, java.lang.String fullName, org.xml.sax.Locator location, javax.xml.namespace.QName typeName, javax.xml.namespace.QName elementName, XSComponent source, CCustomizations customizations)
CClassInfo(Model model, JPackage pkg, java.lang.String shortName, org.xml.sax.Locator location, javax.xml.namespace.QName typeName, javax.xml.namespace.QName elementName, XSComponent source, CCustomizations customizations)
CClassInfo(Model model, CClassInfoParent p, java.lang.String shortName, org.xml.sax.Locator location, javax.xml.namespace.QName typeName, javax.xml.namespace.QName elementName, XSComponent source, CCustomizations customizations)

Method Summary

Modifier and Type	Method	Description
void	_implements(JClass c)
<T> T	accept(CClassInfoParent.Visitor<T> visitor)
void	addConstructor(java.lang.String... fieldNames)	Creates a new constructor declaration and adds it.
void	addProperty(CPropertyInfo prop)	Adds a new property.
com.sun.xml.bind.v2.model.core.Element<NType,NClass>	asElement()
boolean	canBeReferencedByIDREF()	Deprecated. why are you calling an unimplemented method?
JExpression	createConstant(Outline outline, XmlString lexical)
boolean	declaresAttributeWildcard()	Returns true if a new attribute wildcard property needs to be declared on this class.
java.lang.String	fullName()	Returns the FQCN of this bean.
CAdapter	getAdapterUse()
CClassInfo	getBaseClass()	This inherited version returns null if this class extends from CClassRef.
NClass	getClazz()
java.util.Collection<? extends Constructor>	getConstructors()	list all constructor declarations.
CCustomizations	getCustomizations()	Gets the list of customizations attached to this model component.
javax.xml.namespace.QName	getElementName()
javax.activation.MimeType	getExpectedMimeType()	No default MimeType.
CNonElement	getInfo()	Deprecated.
com.sun.xml.bind.v2.runtime.Location	getLocation()
org.xml.sax.Locator	getLocator()	Gets the source location in the schema from which this model component is created.
java.lang.String	getName()
JPackage	getOwnerPackage()	Gets the nearest JPackage.
java.util.List<CPropertyInfo>	getProperties()	Returns a mutable list.
CPropertyInfo	getProperty(java.lang.String name)	Gets a propery by name.
CClassRef	getRefBaseClass()
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()
java.lang.String	getSqueezedName()	Returns the "squeezed name" of this bean token.
CClassInfo	getSubstitutionHead()
NClass	getType()
javax.xml.namespace.QName	getTypeName()
com.sun.xml.bind.v2.model.annotation.Locatable	getUpstream()
java.lang.String	getUserSpecifiedImplClass()
boolean	hasAttributeWildcard()
void	hasAttributeWildcard(boolean hasAttributeWildcard)
boolean	hasProperties()
boolean	hasSubClasses()
boolean	hasValueProperty()
com.sun.xml.bind.v2.model.core.ID	idUse()
boolean	inheritsAttributeWildcard()	Returns true if this class inherits a wildcard attribute property from its ancestor classes.
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()
boolean	isElement()
boolean	isFinal()	Deprecated. if you are calling this method directly, you must be doing something wrong.
boolean	isOrdered()
boolean	isSimpleType()
java.util.Iterator<CClassInfo>	listSubclasses()	Enumerates all the sub-classes of this class.
CClassInfoParent	parent()
void	setAbstract()	Marks this element as an abstract element.
void	setBaseClass(CClass base)	This method accepts both CClassInfo (which means the base class is also generated), or CClassRef (which means the base class is already generated and simply referenced.) The latter is treated somewhat special --- from the rest of the model this external base class is invisible.
void	setOrdered(boolean value)
void	setUserSpecifiedImplClass(java.lang.String implClass)
java.lang.String	toString()
JClass	toType(Outline o, Aspect aspect)	Returns the JClass that represents the class being bound, under the given Outline.

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

getCustomizations, getLocator, getSchemaComponent

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

isAbstract, setAbstract

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

isAbstract

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

getAdapterUse, isCollection

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

getLocation, getUpstream

Methods inherited from interface com.sun.tools.xjc.model.nav.NClass

isAbstract

Methods inherited from class java.lang.Object

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

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

canBeReferencedByIDREF

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

createConstant, getExpectedMimeType, idUse

Field Detail

javadoc

public java.lang.String javadoc

TODO: revisit this design. we should at least do a basic encapsulation to avoid careless mistakes. Maybe we should even differ the javadoc generation by queueing runners.

shortName

public final java.lang.String shortName

short name.

model

public final Model model

The Model object to which this bean belongs.

Constructor Detail

CClassInfo

public CClassInfo(Model model,
                  JPackage pkg,
                  java.lang.String shortName,
                  org.xml.sax.Locator location,
                  javax.xml.namespace.QName typeName,
                  javax.xml.namespace.QName elementName,
                  XSComponent source,
                  CCustomizations customizations)

CClassInfo

public CClassInfo(Model model,
                  CClassInfoParent p,
                  java.lang.String shortName,
                  org.xml.sax.Locator location,
                  javax.xml.namespace.QName typeName,
                  javax.xml.namespace.QName elementName,
                  XSComponent source,
                  CCustomizations customizations)

CClassInfo

public CClassInfo(Model model,
                  JCodeModel cm,
                  java.lang.String fullName,
                  org.xml.sax.Locator location,
                  javax.xml.namespace.QName typeName,
                  javax.xml.namespace.QName elementName,
                  XSComponent source,
                  CCustomizations customizations)

Method Detail

hasAttributeWildcard

public boolean hasAttributeWildcard()

Specified by:

hasAttributeWildcard in interface com.sun.xml.bind.v2.model.core.ClassInfo<NType,NClass>

hasAttributeWildcard

public void hasAttributeWildcard(boolean hasAttributeWildcard)

hasSubClasses

public boolean hasSubClasses()

Specified by:

hasSubClasses in interface com.sun.xml.bind.v2.model.core.ClassInfo<NType,NClass>

declaresAttributeWildcard

public boolean declaresAttributeWildcard()

Returns true if a new attribute wildcard property needs to be declared on this class.

Specified by:

declaresAttributeWildcard in interface com.sun.xml.bind.v2.model.core.ClassInfo<NType,NClass>

inheritsAttributeWildcard

public boolean inheritsAttributeWildcard()

Returns true if this class inherits a wildcard attribute property from its ancestor classes.

Specified by:

inheritsAttributeWildcard in interface com.sun.xml.bind.v2.model.core.ClassInfo<NType,NClass>

getClazz

public NClass getClazz()

Specified by:

getClazz in interface com.sun.xml.bind.v2.model.core.ClassInfo<NType,NClass>

getScope

public CClassInfo getScope()

Specified by:

getScope in interface com.sun.xml.bind.v2.model.core.Element<NType,NClass>

getName

public java.lang.String getName()

Specified by:

getName in interface com.sun.xml.bind.v2.model.core.ClassInfo<NType,NClass>

getSqueezedName

public java.lang.String getSqueezedName()

Returns the "squeezed name" of this bean token.

The squeezed name of a bean is the concatenation of the names of its outer classes and itself.

Thus if the bean is "org.acme.foo.Bean", then the squeezed name is "Bean", if the bean is "org.acme.foo.Outer1.Outer2.Bean", then "Outer1Outer2Bean".

This is used by the code generator

getProperties

public java.util.List<CPropertyInfo> getProperties()

Returns a mutable list.

Specified by:

getProperties in interface com.sun.xml.bind.v2.model.core.ClassInfo<NType,NClass>

hasValueProperty

public boolean hasValueProperty()

Specified by:

hasValueProperty in interface com.sun.xml.bind.v2.model.core.ClassInfo<NType,NClass>

getProperty

public CPropertyInfo getProperty(java.lang.String name)

Gets a propery by name.

Specified by:

getProperty in interface com.sun.xml.bind.v2.model.core.ClassInfo<NType,NClass>

hasProperties

public boolean hasProperties()

Specified by:

hasProperties in interface com.sun.xml.bind.v2.model.core.ClassInfo<NType,NClass>

isElement

public boolean isElement()

Specified by:

isElement in interface com.sun.xml.bind.v2.model.core.MaybeElement<NType,NClass>

getInfo

@Deprecated
public CNonElement getInfo()

Deprecated.

Guaranteed to return this.

Specified by:

getInfo in interface CNonElement

Specified by:

getInfo in interface TypeUse

asElement

public com.sun.xml.bind.v2.model.core.Element<NType,NClass> asElement()

Specified by:

asElement in interface com.sun.xml.bind.v2.model.core.MaybeElement<NType,NClass>

isOrdered

public boolean isOrdered()

Specified by:

isOrdered in interface com.sun.xml.bind.v2.model.core.ClassInfo<NType,NClass>

isFinal

public boolean isFinal()

Deprecated. if you are calling this method directly, you must be doing something wrong.

Specified by:

isFinal in interface com.sun.xml.bind.v2.model.core.ClassInfo<NType,NClass>

setOrdered

public void setOrdered(boolean value)

getElementName

public javax.xml.namespace.QName getElementName()

Specified by:

getElementName in interface com.sun.xml.bind.v2.model.core.Element<NType,NClass>

Specified by:

getElementName in interface com.sun.xml.bind.v2.model.core.MaybeElement<NType,NClass>

getTypeName

public javax.xml.namespace.QName getTypeName()

Specified by:

getTypeName in interface com.sun.xml.bind.v2.model.core.NonElement<NType,NClass>

isSimpleType

public boolean isSimpleType()

Specified by:

isSimpleType in interface com.sun.xml.bind.v2.model.core.NonElement<NType,NClass>

fullName

public java.lang.String fullName()

Returns the FQCN of this bean.

Specified by:

fullName in interface CClassInfoParent

Specified by:

fullName in interface NType

parent

public CClassInfoParent parent()

setUserSpecifiedImplClass

public void setUserSpecifiedImplClass(java.lang.String implClass)

getUserSpecifiedImplClass

public java.lang.String getUserSpecifiedImplClass()

addProperty

public void addProperty(CPropertyInfo prop)

Adds a new property.

setBaseClass

public void setBaseClass(CClass base)

This method accepts both CClassInfo (which means the base class is also generated), or CClassRef (which means the base class is already generated and simply referenced.) The latter is treated somewhat special --- from the rest of the model this external base class is invisible. This modeling might need more thoughts to get right.

getBaseClass

public CClassInfo getBaseClass()

This inherited version returns null if this class extends from CClassRef.

Specified by:

getBaseClass in interface com.sun.xml.bind.v2.model.core.ClassInfo<NType,NClass>

See Also:

getRefBaseClass()

getRefBaseClass

public CClassRef getRefBaseClass()

listSubclasses

public java.util.Iterator<CClassInfo> listSubclasses()

Enumerates all the sub-classes of this class.

getSubstitutionHead

public CClassInfo getSubstitutionHead()

Specified by:

getSubstitutionHead in interface com.sun.xml.bind.v2.model.core.Element<NType,NClass>

_implements

public void _implements(JClass c)

addConstructor

public void addConstructor(java.lang.String... fieldNames)

Creates a new constructor declaration and adds it.

getConstructors

public java.util.Collection<? extends Constructor> getConstructors()

list all constructor declarations.

accept

public final <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

getType

public final NClass getType()

Specified by:

getType in interface com.sun.xml.bind.v2.model.core.TypeInfo<NType,NClass>

toType

public final JClass toType(Outline o,
                           Aspect aspect)

Description copied from interface: CTypeInfo

Returns the JClass that represents the class being bound, under the given Outline.

Specified by:

toType in interface CTypeInfo

Specified by:

toType in interface NClass

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, com.sun.tools.xjc.outline.Aspect)

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

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 com.sun.xml.bind.v2.model.core.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?

Specified by:

canBeReferencedByIDREF in interface com.sun.xml.bind.v2.model.core.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 com.sun.xml.bind.v2.model.annotation.Locatable getUpstream()

Specified by:

getUpstream in interface com.sun.xml.bind.v2.model.annotation.Locatable

getLocation

public final com.sun.xml.bind.v2.runtime.Location getLocation()

Specified by:

getLocation in interface com.sun.xml.bind.v2.model.annotation.Locatable