com.sun.tools.xjc.model
Class CClassInfo

java.lang.Object
  extended by com.sun.tools.xjc.model.CClassInfo
All Implemented Interfaces:
CClass, CClassInfoParent, CCustomizable, CElement, CNonElement, CTypeInfo, NClass, NType, TypeUse, Locatable, ClassInfo<NType,NClass>, Element<NType,NClass>, MaybeElement<NType,NClass>, NonElement<NType,NClass>, TypeInfo<NType,NClass>

public final class CClassInfo
extends Object
implements ClassInfo<NType,NClass>, CClassInfoParent, CClass, NClass

Mutable ClassInfo represenatation.

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
 String javadoc
          TODO: revisit this design.
 Model model
          The Model object to which this bean belongs.
 String shortName
          short name.
 
Fields inherited from interface com.sun.xml.bind.v2.model.core.NonElement
ANYTYPE_NAME
 
Constructor Summary
CClassInfo(Model model, CClassInfoParent p, String shortName, Locator location, QName typeName, QName elementName, XSComponent source, CCustomizations customizations)
           
CClassInfo(Model model, JCodeModel cm, String fullName, Locator location, QName typeName, QName elementName, XSComponent source, CCustomizations customizations)
           
CClassInfo(Model model, JPackage pkg, String shortName, Locator location, QName typeName, QName elementName, XSComponent source, CCustomizations customizations)
           
 
Method Summary
 void _implements(JClass c)
           
<T> T
accept(CClassInfoParent.Visitor<T> visitor)
           
 void addConstructor(String... fieldNames)
          Creates a new constructor declaration and adds it.
 void addProperty(CPropertyInfo prop)
          Adds a new property.
 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.
 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()
           
 Collection<? extends Constructor> getConstructors()
          list all constructor declarations.
 CCustomizations getCustomizations()
          Gets the list of customizations attached to this model component.
 QName getElementName()
           
 MimeType getExpectedMimeType()
          No default MimeType.
 CNonElement getInfo()
          Deprecated. 
 Location getLocation()
           
 Locator getLocator()
          Gets the source location in the schema from which this model component is created.
 String getName()
           
 JPackage getOwnerPackage()
          Gets the nearest JPackage.
 List<CPropertyInfo> getProperties()
          Returns a mutable list.
 CPropertyInfo getProperty(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()
           
 String getSqueezedName()
          Returns the "squeezed name" of this bean token.
 CClassInfo getSubstitutionHead()
           
 NClass getType()
           
 QName getTypeName()
           
 Locatable getUpstream()
           
 String getUserSpecifiedImplClass()
           
 boolean hasAttributeWildcard()
           
 void hasAttributeWildcard(boolean hasAttributeWildcard)
           
 boolean hasProperties()
           
 boolean hasSubClasses()
           
 boolean hasValueProperty()
           
 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()
           
 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(String implClass)
           
 String toString()
           
 JClass toType(Outline o, Aspect aspect)
          Returns the JClass that represents the class being bound, under the given Outline.
 
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.ClassInfo
isAbstract
 
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.CElement
isAbstract, setAbstract
 
Methods inherited from interface com.sun.tools.xjc.model.CCustomizable
getCustomizations, getLocator, getSchemaComponent
 
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.nav.NClass
isAbstract
 

Field Detail

javadoc

public 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 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,
                  String shortName,
                  Locator location,
                  QName typeName,
                  QName elementName,
                  XSComponent source,
                  CCustomizations customizations)

CClassInfo

public CClassInfo(Model model,
                  CClassInfoParent p,
                  String shortName,
                  Locator location,
                  QName typeName,
                  QName elementName,
                  XSComponent source,
                  CCustomizations customizations)

CClassInfo

public CClassInfo(Model model,
                  JCodeModel cm,
                  String fullName,
                  Locator location,
                  QName typeName,
                  QName elementName,
                  XSComponent source,
                  CCustomizations customizations)
Method Detail

hasAttributeWildcard

public boolean hasAttributeWildcard()
Specified by:
hasAttributeWildcard in interface ClassInfo<NType,NClass>

hasAttributeWildcard

public void hasAttributeWildcard(boolean hasAttributeWildcard)

hasSubClasses

public boolean hasSubClasses()
Specified by:
hasSubClasses in interface 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 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 ClassInfo<NType,NClass>

getClazz

public NClass getClazz()
Specified by:
getClazz in interface ClassInfo<NType,NClass>

getScope

public CClassInfo getScope()
Specified by:
getScope in interface Element<NType,NClass>

getName

public String getName()
Specified by:
getName in interface ClassInfo<NType,NClass>

getSqueezedName

public 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 List<CPropertyInfo> getProperties()
Returns a mutable list.

Specified by:
getProperties in interface ClassInfo<NType,NClass>

hasValueProperty

public boolean hasValueProperty()
Specified by:
hasValueProperty in interface ClassInfo<NType,NClass>

getProperty

public CPropertyInfo getProperty(String name)
Gets a propery by name.

Specified by:
getProperty in interface ClassInfo<NType,NClass>

hasProperties

public boolean hasProperties()
Specified by:
hasProperties in interface ClassInfo<NType,NClass>

isElement

public boolean isElement()
Specified by:
isElement in interface 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 Element<NType,NClass> asElement()
Specified by:
asElement in interface MaybeElement<NType,NClass>

isOrdered

public boolean isOrdered()
Specified by:
isOrdered in interface 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 ClassInfo<NType,NClass>

setOrdered

public void setOrdered(boolean value)

getElementName

public QName getElementName()
Specified by:
getElementName in interface Element<NType,NClass>
Specified by:
getElementName in interface MaybeElement<NType,NClass>

getTypeName

public QName getTypeName()
Specified by:
getTypeName in interface NonElement<NType,NClass>

isSimpleType

public boolean isSimpleType()
Specified by:
isSimpleType in interface NonElement<NType,NClass>

fullName

public 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(String implClass)

getUserSpecifiedImplClass

public 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 ClassInfo<NType,NClass>
See Also:
getRefBaseClass()

getRefBaseClass

public CClassRef getRefBaseClass()

listSubclasses

public Iterator<CClassInfo> listSubclasses()
Enumerates all the sub-classes of this class.


getSubstitutionHead

public CClassInfo getSubstitutionHead()
Specified by:
getSubstitutionHead in interface Element<NType,NClass>

_implements

public void _implements(JClass c)

addConstructor

public void addConstructor(String... fieldNames)
Creates a new constructor declaration and adds it.


getConstructors

public 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 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, 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 String toString()
Overrides:
toString in class Object

getLocator

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

Specified by:
canBeReferencedByIDREF in interface TypeInfo<NType,NClass>

getExpectedMimeType

public 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()
Specified by:
getUpstream in interface Locatable

getLocation

public final Location getLocation()
Specified by:
getLocation in interface Locatable


Copyright © 2005-2015 Oracle Corporation. All Rights Reserved.