Module com.sun.tools.xjc

Package com.sun.tools.xjc.model

Class CClassRef

java.lang.Object

com.sun.tools.xjc.model.CClassRef

All Implemented Interfaces:

CClass, CCustomizable, CElement, CNonElement, CTypeInfo, NClass, NType, TypeUse, Locatable, Element<NType,NClass>, NonElement<NType,NClass>, TypeInfo<NType,NClass>

public final class CClassRef
extends java.lang.Object
implements NClass, CClass

Reference to an existing class.

Author:

Kohsuke Kawaguchi

Field Summary

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

ANYTYPE_NAME

Constructor Summary

Constructors

Constructor	Description
CClassRef(Model model, com.sun.xml.xsom.XSComponent source, BIClass decl, CCustomizations customizations)
CClassRef(Model model, com.sun.xml.xsom.XSComponent source, BIEnum decl, CCustomizations customizations)

Method Summary

Modifier and Type	Method	Description
boolean	canBeReferencedByIDREF()	Deprecated. why are you calling an unimplemented method?
com.sun.codemodel.JExpression	createConstant(Outline outline, com.sun.xml.xsom.XmlString lexical)
java.lang.String	fullName()	Human readable name of this type.
CAdapter	getAdapterUse()
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.
Location	getLocation()
org.xml.sax.Locator	getLocator()	Gets the source location in the schema from which this model component is created.
com.sun.xml.xsom.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()
CElement	getSubstitutionHead()
NType	getType()
javax.xml.namespace.QName	getTypeName()
Locatable	getUpstream()
ID	idUse()
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	isSimpleType()
void	setAbstract()	Marks this element as an abstract element.
com.sun.codemodel.JClass	toType(Outline o, Aspect aspect)	Returns the representation of this type in code model.

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

getCustomizations, getLocator, getSchemaComponent

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

createConstant, getExpectedMimeType, idUse

Constructor Detail

CClassRef

public CClassRef(Model model,
                 com.sun.xml.xsom.XSComponent source,
                 BIClass decl,
                 CCustomizations customizations)

Parameters:

decl - The BIClass declaration that has BIClass.getExistingClassRef()

CClassRef

public CClassRef(Model model,
                 com.sun.xml.xsom.XSComponent source,
                 BIEnum decl,
                 CCustomizations customizations)

Parameters:

decl - The BIClass declaration that has BIEnum.ref

Method Detail

setAbstract

public void setAbstract()

Description copied from interface: CElement

Marks this element as an abstract element.

Specified by:

setAbstract in interface CElement

isAbstract

public boolean isAbstract()

Description copied from interface: CElement

Returns true iff this element is an abstract element.

Specified by:

isAbstract in interface CElement

Specified by:

isAbstract in interface NClass

getType

public NType getType()

Specified by:

getType in interface TypeInfo<NType,NClass>

toType

public com.sun.codemodel.JClass 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 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)

fullName

public java.lang.String fullName()

Description copied from interface: NType

Human readable name of this type.

Specified by:

fullName in interface NType

getTypeName

public javax.xml.namespace.QName getTypeName()

Specified by:

getTypeName in interface NonElement<NType,NClass>

getInfo

@Deprecated
public CNonElement getInfo()

Deprecated.

Guaranteed to return this.

Specified by:

getInfo in interface CNonElement

Specified by:

getInfo in interface TypeUse

getSubstitutionHead

public CElement getSubstitutionHead()

Specified by:

getSubstitutionHead in interface Element<NType,NClass>

getScope

public CClassInfo getScope()

Specified by:

getScope in interface Element<NType,NClass>

getElementName

public javax.xml.namespace.QName getElementName()

Specified by:

getElementName in interface Element<NType,NClass>

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

isSimpleType

public boolean isSimpleType()

Specified by:

isSimpleType in interface NonElement<NType,NClass>

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.

isCollection

public final boolean isCollection()

getAdapterUse

public final CAdapter getAdapterUse()

idUse

public final ID idUse()

getSchemaComponent

public final com.sun.xml.xsom.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 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 com.sun.codemodel.JExpression createConstant(Outline outline,
                                                    com.sun.xml.xsom.XmlString lexical)

getUpstream

public final Locatable getUpstream()

Specified by:

getUpstream in interface Locatable

getLocation

public final Location getLocation()

Specified by:

getLocation in interface Locatable