JAXB OSGI 4.0.9 · org.glassfish.jaxb.runtime.v2.model.impl.PropertyInfoImpl

Modifier and Type	Field and Description
private final Adapter<T, C>	adapter
private final MimeType	expectedMimeType
private final ID	id
private final boolean	inlineBinary
private final boolean	isCollection
protected final ClassInfoImpl<T, C, F, M>	parent
private final QName	schemaType
protected final PropertySeed<T, C, F, M>	seed Object that reads annotations.

Access	Constructor and Description
protected	PropertyInfoImpl(ClassInfoImpl<T, C, F, M> parent, PropertySeed<T, C, F, M> spi)

Method Summary

Modifier and Type	Method and Description
private ID	calcId()
protected final QName	calcXmlName(XmlElement e) Computes the tag name from a `XmlElement` by taking the defaulting into account.
protected final QName	calcXmlName(XmlElementWrapper e) Computes the tag name from a `XmlElementWrapper` by taking the defaulting into account.
private QName	calcXmlName(String uri, String local)
public int	compareTo(PropertyInfoImpl<T, C, F, M> that) Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.
public final String	displayName() Implements org.glassfish.jaxb.core.v2.model.core.PropertyInfo.displayName. Gets the display name of the property.
public Adapter<T, C>	getAdapter() Implements org.glassfish.jaxb.core.v2.model.core.PropertyInfo.getAdapter. This is the default implementation of the getAdapter method defined on many of the `PropertyInfo`-derived classes.
private XmlJavaTypeAdapter	getApplicableAdapter(T type)
public final MimeType	getExpectedMimeType() Implements org.glassfish.jaxb.core.v2.model.core.PropertyInfo.getExpectedMimeType. Expected MIME type, if any.
public T	getIndividualType()
public Location	getLocation() Implements org.glassfish.jaxb.core.v2.model.annotation.Locatable.getLocation. Gets the location object that this object points to.
public final String	getName() Implements org.glassfish.jaxb.core.v2.model.core.PropertyInfo.getName. Gets the name of the property.
public T	getRawType()
public final QName	getSchemaType() Implements org.glassfish.jaxb.core.v2.model.core.PropertyInfo.getSchemaType. The effective value of `XmlSchemaType` annotation, if any.
public Locatable	getUpstream() Implements org.glassfish.jaxb.core.v2.model.annotation.Locatable.getUpstream. A is always referenced by its enclosing class, so return that as the upstream.
public final boolean	hasAnnotation(Class<? extends Annotation> annotationType) Implements org.glassfish.jaxb.core.v2.model.annotation.AnnotationSource.hasAnnotation. Returns true if the property has the specified annotation.
public final ID	id() Implements org.glassfish.jaxb.core.v2.model.core.PropertyInfo.id. Returns the IDness of the value of this element.
public final boolean	inlineBinaryData() Implements org.glassfish.jaxb.core.v2.model.core.PropertyInfo.inlineBinaryData. If this is true and this property indeed represents a binary data, it should be always inlined.
private boolean	isApplicable(XmlJavaTypeAdapter jta, T declaredType) Checks if the given adapter is applicable to the declared property type.
public final boolean	isCollection() Implements org.glassfish.jaxb.core.v2.model.core.PropertyInfo.isCollection. Returns true if this is a multi-valued collection property.
protected void	link() Called after all the `TypeInfo`s are collected into the governing `TypeInfoSet`.
protected final Navigator<T, C, F, M>	nav()
public ClassInfoImpl<T, C, F, M>	parent() Implements org.glassfish.jaxb.core.v2.model.core.PropertyInfo.parent. Gets the `ClassInfo` or `ElementInfo` to which this property belongs.
public final <A extends Annotation> A	readAnnotation(Class<A> annotationType) Implements org.glassfish.jaxb.core.v2.model.annotation.AnnotationSource.readAnnotation. Gets the value of the specified annotation from the given property.
protected final AnnotationReader<T, C, F, M>	reader()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

adapter	back to summary
private final Adapter<T, C> adapter

expectedMimeType	back to summary
private final MimeType expectedMimeType

id	back to summary
private final ID id

inlineBinary	back to summary
private final boolean inlineBinary

isCollection	back to summary
private final boolean isCollection

parent	back to summary
protected final ClassInfoImpl<T, C, F, M> parent

schemaType	back to summary
private final QName schemaType

seed	back to summary
protected final PropertySeed<T, C, F, M> seed Object that reads annotations.

PropertyInfoImpl	back to summary
protected PropertyInfoImpl(ClassInfoImpl<T, C, F, M> parent, PropertySeed<T, C, F, M> spi)

Method Detail

calcId	back to summary
private ID calcId()

calcXmlName	back to summary
protected final QName calcXmlName(XmlElement e) Computes the tag name from a `XmlElement` by taking the defaulting into account.

calcXmlName	back to summary
protected final QName calcXmlName(XmlElementWrapper e) Computes the tag name from a `XmlElementWrapper` by taking the defaulting into account.

calcXmlName	back to summary
private QName calcXmlName(String uri, String local)

compareTo back to summary

compareTo	back to summary
public int compareTo(PropertyInfoImpl<T, C, F, M> that) Implements java.lang.Comparable.compareTo. Doc from java.lang.Comparable.compareTo. Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. The implementor must ensure `signum(x.compareTo(y)) == -signum(y.compareTo(x))` for all `x` and `y`. (This implies that `x.compareTo(y)` must throw an exception if and only if `y.compareTo(x)` throws an exception.) The implementor must also ensure that the relation is transitive: `(x.compareTo(y) > 0 && y.compareTo(z) > 0)` implies `x.compareTo(z) > 0`. Finally, the implementor must ensure that `x.compareTo(y)==0` implies that `signum(x.compareTo(z)) == signum(y.compareTo(z))`, for all `z`. Annotations @Override

public int compareTo(PropertyInfoImpl<T, C, F, M> that)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Annotations

@Override

displayName back to summary

displayName	back to summary
public final String displayName() Implements org.glassfish.jaxb.core.v2.model.core.PropertyInfo.displayName. Doc from org.glassfish.jaxb.core.v2.model.core.PropertyInfo.displayName. Gets the display name of the property. This is a convenience method for `parent().getName()+'#'+getName()`. Annotations @Override

public final String displayName()

Implements org.glassfish.jaxb.core.v2.model.core.PropertyInfo.displayName.

Doc from org.glassfish.jaxb.core.v2.model.core.PropertyInfo.displayName.

Gets the display name of the property.

This is a convenience method for parent().getName()+'#'+getName().

Annotations

@Override

getAdapter back to summary

getAdapter	back to summary
public Adapter<T, C> getAdapter() Implements org.glassfish.jaxb.core.v2.model.core.PropertyInfo.getAdapter. This is the default implementation of the getAdapter method defined on many of the `PropertyInfo`-derived classes. Annotations @Override

public Adapter<T, C> getAdapter()

Implements org.glassfish.jaxb.core.v2.model.core.PropertyInfo.getAdapter.

This is the default implementation of the getAdapter method defined on many of the PropertyInfo-derived classes.

Annotations

@Override

getApplicableAdapter	back to summary
private XmlJavaTypeAdapter getApplicableAdapter(T type)

getExpectedMimeType	back to summary
public final MimeType getExpectedMimeType() Implements org.glassfish.jaxb.core.v2.model.core.PropertyInfo.getExpectedMimeType. Doc from org.glassfish.jaxb.core.v2.model.core.PropertyInfo.getExpectedMimeType. Expected MIME type, if any. Annotations @Override

getExpectedMimeType

back to summary

public final MimeType getExpectedMimeType()

Implements org.glassfish.jaxb.core.v2.model.core.PropertyInfo.getExpectedMimeType.

Doc from org.glassfish.jaxb.core.v2.model.core.PropertyInfo.getExpectedMimeType.

Expected MIME type, if any.

Annotations

@Override

getIndividualType	back to summary
public T getIndividualType()

getLocation	back to summary
public Location getLocation() Implements org.glassfish.jaxb.core.v2.model.annotation.Locatable.getLocation. Doc from org.glassfish.jaxb.core.v2.model.annotation.Locatable.getLocation. Gets the location object that this object points to. This operation could be inefficient and costly. Annotations @Override

getLocation

back to summary

public Location getLocation()

Implements org.glassfish.jaxb.core.v2.model.annotation.Locatable.getLocation.

Doc from org.glassfish.jaxb.core.v2.model.annotation.Locatable.getLocation.

Gets the location object that this object points to. This operation could be inefficient and costly.

Annotations

@Override

getName	back to summary
public final String getName() Implements org.glassfish.jaxb.core.v2.model.core.PropertyInfo.getName. Doc from org.glassfish.jaxb.core.v2.model.core.PropertyInfo.getName. Gets the name of the property. For example, "foo" or "bar". Generally, a property name is different from XML, (although they are often related, as a property name is often computed from tag names / attribute names.) In fact, property names do not directly affect XML. The property name uniquely identifies a property within a class. Annotations @Override

getName

back to summary

public final String getName()

Implements org.glassfish.jaxb.core.v2.model.core.PropertyInfo.getName.

Doc from org.glassfish.jaxb.core.v2.model.core.PropertyInfo.getName.

Gets the name of the property.

For example, "foo" or "bar". Generally, a property name is different from XML, (although they are often related, as a property name is often computed from tag names / attribute names.) In fact, property names do not directly affect XML. The property name uniquely identifies a property within a class.

Annotations

@Override

getRawType	back to summary
public T getRawType()

getSchemaType back to summary

getSchemaType	back to summary
public final QName getSchemaType() Implements org.glassfish.jaxb.core.v2.model.core.PropertyInfo.getSchemaType. Doc from org.glassfish.jaxb.core.v2.model.core.PropertyInfo.getSchemaType. The effective value of `XmlSchemaType` annotation, if any. If the property doesn't have `XmlSchemaType` annotation, this method returns null. Since a type name is a property of a Java type, not a Java property, A schema type name of a Java type should be primarily obtained by using `NonElement#getTypeName()`. This method is to correctly implement the ugly semantics of `XmlSchemaType` (namely when this returns non-null, it overrides the type names of all types that are in this property.) Annotations @Override

public final QName getSchemaType()

Implements org.glassfish.jaxb.core.v2.model.core.PropertyInfo.getSchemaType.

Doc from org.glassfish.jaxb.core.v2.model.core.PropertyInfo.getSchemaType.

The effective value of XmlSchemaType annotation, if any.

If the property doesn't have XmlSchemaType annotation, this method returns null.

Since a type name is a property of a Java type, not a Java property, A schema type name of a Java type should be primarily obtained by using NonElement#getTypeName(). This method is to correctly implement the ugly semantics of XmlSchemaType (namely when this returns non-null, it overrides the type names of all types that are in this property.)

Annotations

@Override

getUpstream	back to summary
public Locatable getUpstream() Implements org.glassfish.jaxb.core.v2.model.annotation.Locatable.getUpstream. A is always referenced by its enclosing class, so return that as the upstream. Annotations @Override

getUpstream

back to summary

public Locatable getUpstream()

Implements org.glassfish.jaxb.core.v2.model.annotation.Locatable.getUpstream.

A is always referenced by its enclosing class, so return that as the upstream.

Annotations

@Override

hasAnnotation back to summary

hasAnnotation	back to summary
public final boolean hasAnnotation(Class<? extends Annotation> annotationType) Implements org.glassfish.jaxb.core.v2.model.annotation.AnnotationSource.hasAnnotation. Doc from org.glassfish.jaxb.core.v2.model.annotation.AnnotationSource.hasAnnotation. Returns true if the property has the specified annotation. Short for `readAnnotation(annotationType)!=null`, but this method is typically faster. Annotations @Override

public final boolean hasAnnotation(Class<? extends Annotation> annotationType)

Implements org.glassfish.jaxb.core.v2.model.annotation.AnnotationSource.hasAnnotation.

Doc from org.glassfish.jaxb.core.v2.model.annotation.AnnotationSource.hasAnnotation.

Returns true if the property has the specified annotation.

Short for readAnnotation(annotationType)!=null, but this method is typically faster.

Annotations

@Override

id	back to summary
public final ID id() Implements org.glassfish.jaxb.core.v2.model.core.PropertyInfo.id. Doc from org.glassfish.jaxb.core.v2.model.core.PropertyInfo.id. Returns the IDness of the value of this element. Annotations @Override

back to summary

public final ID id()

Implements org.glassfish.jaxb.core.v2.model.core.PropertyInfo.id.

Doc from org.glassfish.jaxb.core.v2.model.core.PropertyInfo.id.

Returns the IDness of the value of this element.

Annotations

@Override

inlineBinaryData	back to summary
public final boolean inlineBinaryData() Implements org.glassfish.jaxb.core.v2.model.core.PropertyInfo.inlineBinaryData. Doc from org.glassfish.jaxb.core.v2.model.core.PropertyInfo.inlineBinaryData. If this is true and this property indeed represents a binary data, it should be always inlined. Annotations @Override

inlineBinaryData

back to summary

public final boolean inlineBinaryData()

Implements org.glassfish.jaxb.core.v2.model.core.PropertyInfo.inlineBinaryData.

Doc from org.glassfish.jaxb.core.v2.model.core.PropertyInfo.inlineBinaryData.

If this is true and this property indeed represents a binary data, it should be always inlined.

Annotations

@Override

isApplicable	back to summary
private boolean isApplicable(XmlJavaTypeAdapter jta, T declaredType) Checks if the given adapter is applicable to the declared property type.

isCollection	back to summary
public final boolean isCollection() Implements org.glassfish.jaxb.core.v2.model.core.PropertyInfo.isCollection. Doc from org.glassfish.jaxb.core.v2.model.core.PropertyInfo.isCollection. Returns true if this is a multi-valued collection property. Otherwise false, in which case the property is a single value. Annotations @Override

isCollection

back to summary

public final boolean isCollection()

Implements org.glassfish.jaxb.core.v2.model.core.PropertyInfo.isCollection.

Doc from org.glassfish.jaxb.core.v2.model.core.PropertyInfo.isCollection.

Returns true if this is a multi-valued collection property. Otherwise false, in which case the property is a single value.

Annotations

@Override

link	back to summary
protected void link() Called after all the `TypeInfo`s are collected into the governing `TypeInfoSet`. Derived class can do additional actions to complete the model.

nav

back to summary

protected final Navigator<T, C, F, M> nav()

parent back to summary

parent	back to summary
public ClassInfoImpl<T, C, F, M> parent() Implements org.glassfish.jaxb.core.v2.model.core.PropertyInfo.parent. Doc from org.glassfish.jaxb.core.v2.model.core.PropertyInfo.parent. Gets the `ClassInfo` or `ElementInfo` to which this property belongs. Annotations @Override

public ClassInfoImpl<T, C, F, M> parent()

Implements org.glassfish.jaxb.core.v2.model.core.PropertyInfo.parent.

Doc from org.glassfish.jaxb.core.v2.model.core.PropertyInfo.parent.

Gets the ClassInfo or ElementInfo to which this property belongs.

Annotations

@Override

readAnnotation	back to summary
public final <A extends Annotation> A readAnnotation(Class<A> annotationType) Implements org.glassfish.jaxb.core.v2.model.annotation.AnnotationSource.readAnnotation. Doc from org.glassfish.jaxb.core.v2.model.annotation.AnnotationSource.readAnnotation. Gets the value of the specified annotation from the given property. When this method is used for a property that consists of a getter and setter, it returns the annotation on either of those methods. If both methods have the same annotation, it is an error. Annotations @Override

readAnnotation

back to summary

public final <A extends Annotation> A readAnnotation(Class<A> annotationType)

Implements org.glassfish.jaxb.core.v2.model.annotation.AnnotationSource.readAnnotation.

Doc from org.glassfish.jaxb.core.v2.model.annotation.AnnotationSource.readAnnotation.

Gets the value of the specified annotation from the given property.

When this method is used for a property that consists of a getter and setter, it returns the annotation on either of those methods. If both methods have the same annotation, it is an error.

Annotations

@Override

reader	back to summary
protected final AnnotationReader<T, C, F, M> reader()

pack-priv abstract Class PropertyInfoImpl<T, C, F, M>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail