JAXB OSGI 4.0.9 · org.glassfish.jaxb.core.v2.model.core.PropertyInfo

Method Summary

Modifier and Type	Method and Description
public String	displayName() Gets the display name of the property.
public Adapter<T, C>	getAdapter() Returns: null if the property is not adapted.
public MimeType	getExpectedMimeType() Expected MIME type, if any.
public String	getName() Gets the name of the property.
public QName	getSchemaType() The effective value of `XmlSchemaType` annotation, if any.
public ID	Returns: always non-null id() Returns the IDness of the value of this element.
public boolean	inlineBinaryData() If this is true and this property indeed represents a binary data, it should be always inlined.
public boolean	isCollection() Returns true if this is a multi-valued collection property.
public PropertyKind	Returns: always non-null. kind() Gets the kind of this property.
public TypeInfo<T, C>	parent() Gets the `ClassInfo` or `ElementInfo` to which this property belongs.
public Collection<? extends TypeInfo<T, C>>	Returns: non-null read-only collection. ref() List of `TypeInfo`s that this property references.

Inherited from org.glassfish.jaxb.core.v2.model.annotation.AnnotationSource:: hasAnnotation readAnnotation

Method Detail

displayName back to summary

displayName	back to summary
public String displayName() Gets the display name of the property. This is a convenience method for `parent().getName()+'#'+getName()`.

public String displayName()

Gets the display name of the property.

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

getAdapter	back to summary
public Adapter<T, C> getAdapter() Returns:Adapter<T, C> null if the property is not adapted.

getExpectedMimeType	back to summary
public MimeType getExpectedMimeType() Expected MIME type, if any.

getName back to summary

getName	back to summary
public String 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. See Also `XmlType#propOrder()`

public String 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.

See Also: XmlType#propOrder()

getSchemaType back to summary

getSchemaType	back to summary
public QName 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 @Nullable

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

@Nullable

id back to summary

id	back to summary
public ID id() Returns the IDness of the value of this element. Returns:ID always non-null See Also `XmlID`, `XmlIDREF`

public ID id()

Returns the IDness of the value of this element.

Returns:ID: always non-null
See Also: XmlID, XmlIDREF

inlineBinaryData	back to summary
public boolean inlineBinaryData() If this is true and this property indeed represents a binary data, it should be always inlined.

isCollection	back to summary
public boolean isCollection() Returns true if this is a multi-valued collection property. Otherwise false, in which case the property is a single value.

kind	back to summary
public PropertyKind kind() Gets the kind of this property. Returns:PropertyKind always non-null.

kind

back to summary

public PropertyKind kind()

Gets the kind of this property.

Returns:PropertyKind: always non-null.

parent	back to summary
public TypeInfo<T, C> parent() Gets the `ClassInfo` or `ElementInfo` to which this property belongs.

ref back to summary

ref	back to summary
public Collection<? extends TypeInfo<T, C>> ref() List of `TypeInfo`s that this property references. This allows the caller to traverse the reference graph without getting into the details of each different property type. Returns:Collection<? extends TypeInfo<T, C>> non-null read-only collection.

public Collection<? extends TypeInfo<T, C>> ref()

List of TypeInfos that this property references. This allows the caller to traverse the reference graph without getting into the details of each different property type.

Returns:Collection<? extends TypeInfo<T, C>>: non-null read-only collection.

public Interface PropertyInfo<T, C>

Method Summary

Method Detail