com.sun.tools.xjc.model
Class CClassInfo

java.lang.Object
  com.sun.tools.xjc.model.AbstractCTypeInfoImpl
      com.sun.tools.xjc.model.AbstractCElement
          com.sun.tools.xjc.model.CClassInfo

All Implemented Interfaces:

CClass, CClassInfoParent, CCustomizable, CElement, CNonElement, CTypeInfo, NClass, NType, TypeUse

public final class CClassInfo
extends AbstractCElement
implements CClassInfoParent, CClass, NClass

Mutable ClassInfo represenatation.

Schema parsers build these objects.

Nested Class Summary

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

CClassInfoParent.Package, CClassInfoParent.Visitor<T>

Field Summary

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

Constructor Summary

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

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

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

Method Summary

void	_implements(com.sun.codemodel.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.
	asElement()
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.
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.
javax.xml.namespace.QName	getElementName()
CNonElement	getInfo() Deprecated.
java.lang.String	getName()
com.sun.codemodel.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()
CClassInfo	getScope()
java.lang.String	getSqueezedName() Returns the "squeezed name" of this bean token.
CClassInfo	getSubstitutionHead()
NClass	getType()
javax.xml.namespace.QName	getTypeName()
java.lang.String	getUserSpecifiedImplClass()
boolean	hasAttributeWildcard()
void	hasAttributeWildcard(boolean hasAttributeWildcard)
boolean	hasProperties()
boolean	hasSubClasses()
boolean	hasValueProperty()
boolean	inheritsAttributeWildcard() Returns true if this class inherits a wildcard attribute property from its ancestor classes.
boolean	isBoxedType() Returns true iff this type represents a class that has a unboxed form.
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	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()
com.sun.codemodel.JClass	toType(Outline o, Aspect aspect) Returns the JClass that represents the class being bound, under the given Outline.

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

getLocator, isAbstract, setAbstract

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

canBeReferencedByIDREF, createConstant, getAdapterUse, getCustomizations, getExpectedMimeType, getLocation, getSchemaComponent, getUpstream, idUse, isCollection

Methods inherited from class java.lang.Object

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

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

getAdapterUse, isCollection

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

createConstant, getExpectedMimeType, idUse

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.tools.xjc.model.CCustomizable

getCustomizations, getLocator, getSchemaComponent

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

isAbstract

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,
                  com.sun.codemodel.JPackage pkg,
                  java.lang.String shortName,
                  org.xml.sax.Locator location,
                  javax.xml.namespace.QName typeName,
                  javax.xml.namespace.QName elementName,
                  com.sun.xml.xsom.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,
                  com.sun.xml.xsom.XSComponent source,
                  CCustomizations customizations)

CClassInfo

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

Method Detail

hasAttributeWildcard

public boolean hasAttributeWildcard()

hasAttributeWildcard

public void hasAttributeWildcard(boolean hasAttributeWildcard)

hasSubClasses

public boolean hasSubClasses()

declaresAttributeWildcard

public boolean declaresAttributeWildcard()

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

inheritsAttributeWildcard

public boolean inheritsAttributeWildcard()

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

getClazz

public NClass getClazz()

getScope

public CClassInfo getScope()

getName

public java.lang.String getName()

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.

hasValueProperty

public boolean hasValueProperty()

getProperty

public CPropertyInfo getProperty(java.lang.String name)

Gets a propery by name.

hasProperties

public boolean hasProperties()

isElement

public boolean isElement()

getInfo

@Deprecated
public CNonElement getInfo()

Deprecated.

Guaranteed to return this.

Specified by:

getInfo in interface CNonElement

Specified by:

getInfo in interface TypeUse

asElement

public  asElement()

isOrdered

public boolean isOrdered()

isFinal

public boolean isFinal()

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

setOrdered

public void setOrdered(boolean value)

getElementName

public javax.xml.namespace.QName getElementName()

getTypeName

public javax.xml.namespace.QName getTypeName()

isSimpleType

public boolean isSimpleType()

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.

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()

_implements

public void _implements(com.sun.codemodel.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 com.sun.codemodel.JPackage getOwnerPackage()

Description copied from interface: CClassInfoParent

Gets the nearest JPackage.

Specified by:

getOwnerPackage in interface CClassInfoParent

getType

public final NClass getType()

toType

public final com.sun.codemodel.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, 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