JAXB OSGI 4.0.9 · com.sun.tools.xjc.model.TypeUse · APIdia, the JavaDoc alternative

Information about how another type is referenced.

In practice it is often easier to use CTypeInfo instead of NType, so this interface defines getInfo().

Method Summary

Modifier and Type	Method and Description
public JExpression	Returns: null if the constant cannot be created for this (such as when it's a collection) createConstant(Outline outline, XmlString lexical) Creates a constant for the given lexical value.
public CAdapter	getAdapterUse() If this type use is adapting the type, returns the adapter.
public MimeType	getExpectedMimeType() A can have an associated MIME type.
public CNonElement	getInfo() Individual item type.
public ID	idUse() Whether the referenced type (individual item type in case of collection) is ID/IDREF.
public boolean	isCollection() If the use can hold multiple values of the specified type.

Method Detail

createConstant back to summary

createConstant	back to summary
public JExpression createConstant(Outline outline, XmlString lexical) Creates a constant for the given lexical value. For example, to create a constant 1 for `xs:int`, you'd do: CBuiltinLeafInfo.INT.createConstant( codeModel, "1", null ); This method is invoked at the backend as a part of the code generation process. Returns:JExpression null if the constant cannot be created for this (such as when it's a collection) Exceptions IllegalStateException: if the type isn't bound to a text in XML.

public JExpression createConstant(Outline outline, XmlString lexical)

Creates a constant for the given lexical value.

For example, to create a constant 1 for xs:int, you'd do:

CBuiltinLeafInfo.INT.createConstant( codeModel, "1", null );

This method is invoked at the backend as a part of the code generation process.

Returns:JExpression

null if the constant cannot be created for this (such as when it's a collection)

Exceptions

IllegalStateException:: if the type isn't bound to a text in XML.

getAdapterUse	back to summary
public CAdapter getAdapterUse() If this type use is adapting the type, returns the adapter. Otherwise return null.

getExpectedMimeType	back to summary
public MimeType getExpectedMimeType() A can have an associated MIME type.

getInfo	back to summary
public CNonElement getInfo() Individual item type.

idUse	back to summary
public ID idUse() Whether the referenced type (individual item type in case of collection) is ID/IDREF. ID is a property of a relationship. When a bean Foo has an ID property called 'bar' whose type is String, Foo isn't an ID, String isn't an ID, but this relationship is an ID (in the sense that Foo uses this String as an ID.) The same thing can be said with IDREF. When Foo refers to Bar by means of IDREF, neither Foo nor Bar is IDREF. That's why we have this method in .

idUse

back to summary

public ID idUse()

Whether the referenced type (individual item type in case of collection) is ID/IDREF.

ID is a property of a relationship. When a bean Foo has an ID property called 'bar' whose type is String, Foo isn't an ID, String isn't an ID, but this relationship is an ID (in the sense that Foo uses this String as an ID.)

The same thing can be said with IDREF. When Foo refers to Bar by means of IDREF, neither Foo nor Bar is IDREF.

That's why we have this method in .

isCollection	back to summary
public boolean isCollection() If the use can hold multiple values of the specified type.

public Interface TypeUse

Method Summary

Method Detail