Top Description Fields Constructors Methods
com.sun.tools.xjc.model

pack-priv final Class TypeUseImpl

extends Object
implements TypeUse
Class Inheritance
All Implemented Interfaces
com.sun.tools.xjc.model.TypeUse
Imports
jakarta.activation.MimeType, jakarta.xml.bind.annotation.adapters.XmlAdapter, com.sun.codemodel.JExpr, .JExpression, .JStringLiteral, com.sun.tools.xjc.outline.Outline, org.glassfish.jaxb.core.v2.ClassFactory, org.glassfish.jaxb.core.v2.model.core.ID, com.sun.xml.xsom.XmlString, java.util.Objects

General-purpose TypeUse implementation.
Author
Kohsuke Kawaguchi

Field Summary

Modifier and TypeField and Description
private final CAdapter
private final boolean
private final CNonElement
private final MimeType
private final ID

Constructor Summary

AccessConstructor and Description
public
TypeUseImpl(CNonElement itemType, boolean collection, ID id, MimeType expectedMimeType, CAdapter adapter)

Method Summary

Modifier and TypeMethod and Description
public JExpression
createConstant(Outline outline, XmlString lexical)

Implements com.sun.tools.xjc.model.TypeUse.createConstant.

Creates a constant for the given lexical value.

public boolean
equals(Object o)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public CAdapter
getAdapterUse()

Implements com.sun.tools.xjc.model.TypeUse.getAdapterUse.

If this type use is adapting the type, returns the adapter.

public MimeType
getExpectedMimeType()

Implements com.sun.tools.xjc.model.TypeUse.getExpectedMimeType.

A can have an associated MIME type.

public CNonElement
getInfo()

Implements com.sun.tools.xjc.model.TypeUse.getInfo.

Individual item type.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public ID
idUse()

Implements com.sun.tools.xjc.model.TypeUse.idUse.

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

public boolean
isCollection()

Implements com.sun.tools.xjc.model.TypeUse.isCollection.

If the use can hold multiple values of the specified type.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

adapterback to summary
private final CAdapter adapter
collectionback to summary
private final boolean collection
coreTypeback to summary
private final CNonElement coreType
expectedMimeTypeback to summary
private final MimeType expectedMimeType
idback to summary
private final ID id

Constructor Detail

TypeUseImplback to summary
public TypeUseImpl(CNonElement itemType, boolean collection, ID id, MimeType expectedMimeType, CAdapter adapter)

Method Detail

createConstantback to summary
public JExpression createConstant(Outline outline, XmlString lexical)

Implements com.sun.tools.xjc.model.TypeUse.createConstant.

Doc from com.sun.tools.xjc.model.TypeUse.createConstant.

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.

Annotations
@Override
@SuppressWarnings:unchecked, rawtypes
equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations
@Override
getAdapterUseback to summary
public CAdapter getAdapterUse()

Implements com.sun.tools.xjc.model.TypeUse.getAdapterUse.

Doc from com.sun.tools.xjc.model.TypeUse.getAdapterUse.

If this type use is adapting the type, returns the adapter. Otherwise return null.

Annotations
@Override
getExpectedMimeTypeback to summary
public MimeType getExpectedMimeType()

Implements com.sun.tools.xjc.model.TypeUse.getExpectedMimeType.

Doc from com.sun.tools.xjc.model.TypeUse.getExpectedMimeType.

A can have an associated MIME type.

Annotations
@Override
getInfoback to summary
public CNonElement getInfo()

Implements com.sun.tools.xjc.model.TypeUse.getInfo.

Doc from com.sun.tools.xjc.model.TypeUse.getInfo.

Individual item type.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Annotations
@Override
idUseback to summary
public ID idUse()

Implements com.sun.tools.xjc.model.TypeUse.idUse.

Doc from com.sun.tools.xjc.model.TypeUse.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 .

Annotations
@Override
isCollectionback to summary
public boolean isCollection()

Implements com.sun.tools.xjc.model.TypeUse.isCollection.

Doc from com.sun.tools.xjc.model.TypeUse.isCollection.

If the use can hold multiple values of the specified type.

Annotations
@Override