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

Method Summary

Modifier and Type	Method and Description
public Adapter<T, C>	getAdapter() Redeclares org.glassfish.jaxb.core.v2.model.core.PropertyInfo.getAdapter.
public C	Returns: null if the wildcard is not allowed on this element. getDOMHandler() If this property supports the wildcard, returns its DOM handler.
public Set<? extends Element<T, C>>	Returns: Always non-null. Contains at least one entry. getElements() Returns the information about the possible elements in this property.
public WildcardMode	Returns: null if the wildcard is not allowed on this element. getWildcard() If this property supports the wildcard, returns its mode.
public QName	Returns: must be null if not collection. If the property is a collection, this can be null (in which case there'll be no wrapper), or it can be non-null (in which case there'll be a wrapper) getXmlName() Gets the wrapper element name.
public boolean	isCollectionNillable() Returns true if this property is nillable (meaning the absence of the value is treated as nil='true') This method is only used when this property is a collection.
public boolean	Returns: Always false if `getXmlName()`==null. isCollectionRequired() Checks if the wrapper element is required.
public boolean	isMixed() Returns true if this property can hold `String`s to represent mixed content model.
public boolean	isRequired() Returns true if this element is mandatory.
public Collection<? extends TypeInfo<T, C>>	ref() Redeclares org.glassfish.jaxb.core.v2.model.core.PropertyInfo.ref. List of `TypeInfo`s that this property references.

Inherited from org.glassfish.jaxb.core.v2.model.core.PropertyInfo:: displayName getExpectedMimeType getName getSchemaType id inlineBinaryData isCollection kind parent

Method Detail

getAdapter	back to summary
public Adapter<T, C> getAdapter() Redeclares org.glassfish.jaxb.core.v2.model.core.PropertyInfo.getAdapter. Annotations @Override

getAdapter

back to summary

public Adapter<T, C> getAdapter()

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

Annotations

@Override

getDOMHandler	back to summary
public C getDOMHandler() If this property supports the wildcard, returns its DOM handler. Returns:C null if the wildcard is not allowed on this element.

getDOMHandler

back to summary

public C getDOMHandler()

If this property supports the wildcard, returns its DOM handler.

Returns:C: null if the wildcard is not allowed on this element.

getElements	back to summary
public Set<? extends Element<T, C>> getElements() Returns the information about the possible elements in this property. As of 2004/08/17, the spec only allows you to use different element names when a property is a collection, but I think there's really no reason to limit it there --- if the user wants to use a different tag name for different objects, I don't see why this can be limited to collections. So this is a generalization of the spec. We always allow a property to have multiple types and use different tag names for it, depending on the actual type. In most of the cases, this collection only contains 1 item. So the runtime system is encouraged to provide a faster code-path that is optimized toward such cases. Returns:Set<? extends Element<T, C>> Always non-null. Contains at least one entry.

getElements

back to summary

public Set<? extends Element<T, C>> getElements()

Returns the information about the possible elements in this property.

As of 2004/08/17, the spec only allows you to use different element names when a property is a collection, but I think there's really no reason to limit it there --- if the user wants to use a different tag name for different objects, I don't see why this can be limited to collections.

So this is a generalization of the spec. We always allow a property to have multiple types and use different tag names for it, depending on the actual type.

In most of the cases, this collection only contains 1 item. So the runtime system is encouraged to provide a faster code-path that is optimized toward such cases.

Returns:Set<? extends Element<T, C>>: Always non-null. Contains at least one entry.

getWildcard	back to summary
public WildcardMode getWildcard() If this property supports the wildcard, returns its mode. Returns:WildcardMode null if the wildcard is not allowed on this element.

getWildcard

back to summary

public WildcardMode getWildcard()

If this property supports the wildcard, returns its mode.

Returns:WildcardMode: null if the wildcard is not allowed on this element.

getXmlName	back to summary
public QName getXmlName() Gets the wrapper element name. Returns:QName must be null if not collection. If the property is a collection, this can be null (in which case there'll be no wrapper), or it can be non-null (in which case there'll be a wrapper)

getXmlName

back to summary

public QName getXmlName()

Gets the wrapper element name.

Returns:QName: must be null if not collection. If the property is a collection, this can be null (in which case there'll be no wrapper), or it can be non-null (in which case there'll be a wrapper)

isCollectionNillable	back to summary
public boolean isCollectionNillable() Returns true if this property is nillable (meaning the absence of the value is treated as nil='true') This method is only used when this property is a collection.

isCollectionNillable

back to summary

public boolean isCollectionNillable()

Returns true if this property is nillable (meaning the absence of the value is treated as nil='true')

This method is only used when this property is a collection.

isCollectionRequired back to summary

isCollectionRequired	back to summary
public boolean isCollectionRequired() Checks if the wrapper element is required. Returns:boolean Always false if `getXmlName()`==null.

public boolean isCollectionRequired()

Checks if the wrapper element is required.

Returns:boolean: Always false if getXmlName()==null.

isMixed	back to summary
public boolean isMixed() Returns true if this property can hold `String`s to represent mixed content model.

isRequired	back to summary
public boolean isRequired() Returns true if this element is mandatory.

ref back to summary

ref	back to summary
public Collection<? extends TypeInfo<T, C>> ref() Redeclares org.glassfish.jaxb.core.v2.model.core.PropertyInfo.ref. Doc from org.glassfish.jaxb.core.v2.model.core.PropertyInfo.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.. If this has a wildcard in it, then the returned list will contain `WildcardTypeInfo`. Annotations @Override

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

Redeclares org.glassfish.jaxb.core.v2.model.core.PropertyInfo.ref.

Doc from org.glassfish.jaxb.core.v2.model.core.PropertyInfo.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.. If this has a wildcard in it, then the returned list will contain WildcardTypeInfo.

Annotations

@Override

public Interface ReferencePropertyInfo<T, C>

Method Summary

Method Detail