com.sun.xml.bind.v2.model.core

Interface ClassInfo<T,C>

public interface ClassInfo<T,C> extends MaybeElement<T,C>

Information about JAXB-bound class.

All the JAXB annotations are already reflected to the model so that the caller doesn't have to worry about them. For this reason, you cannot access annotations on properties.

XML representation

A JAXB-bound class always have at least one representation (called "type representation"),but it can optionally have another representation ("element representation").

In the type representaion, a class is represented as a set of attributes and (elements or values). You can inspect the details of those attributes/elements/values by getProperties. This representation corresponds to a complex/simple type in XML Schema. You can obtain the schema type name by ClassInfo.

If a class has an element representation, ClassInfo returns true. This representation is mostly similar to the type representation except that the whoe attributes/elements/values are wrapped into one element. You can obtain the name of this element through ClassInfo.

Method Summary
booleandeclaresAttributeWildcard()
Returns true iff this class declares a wildcard attribute.
ClassInfo<T,C>getBaseClass()
Obtains the information about the base class.
CgetClazz()
Gets the declaration this object is wrapping.
StringgetName()
Gets the fully-qualified name of the class.
List<? extends PropertyInfo<T,C>>getProperties()
Returns all the properties newly declared in this class.
PropertyInfo<T,C>getProperty(String name)
Gets the property that has the specified name.
booleanhasAttributeWildcard()
Returns true if this bean class has an attribute wildcard.
booleanhasProperties()
If the class has properties, return true.
booleanhasSubClasses()
True if there's a known sub-type of this class in TypeInfoSet.
booleanhasValueProperty()
Returns true if this class or its ancestor has XmlValue property.
booleaninheritsAttributeWildcard()
Returns true iff this class inherits a wildcard attribute from its ancestor classes.
booleanisAbstract()
If this class is abstract and thus shall never be directly instanciated.
booleanisFinal()
If this class is marked as final and no further extension/restriction is allowed.
booleanisOrdered()
Returns true if the properties of this class is ordered in XML.

Method Detail

declaresAttributeWildcard

public boolean declaresAttributeWildcard()
Returns true iff this class declares a wildcard attribute.

getBaseClass

public ClassInfo<T,C> getBaseClass()
Obtains the information about the base class.

Returns: null if this info extends from Object.

getClazz

public C getClazz()
Gets the declaration this object is wrapping.

getName

public String getName()
Gets the fully-qualified name of the class.

getProperties

public List<? extends PropertyInfo<T,C>> getProperties()
Returns all the properties newly declared in this class.

This excludes properties defined in the super class.

If the properties are ordered, it will be returned in the order that appear in XML. Otherwise it will be returned in no particular order.

Properties marked with XmlTransient will not show up in this list. As far as JAXB is concerned, they are considered non-existent.

Returns: always non-null, but can be empty.

getProperty

public PropertyInfo<T,C> getProperty(String name)
Gets the property that has the specified name.

This is just a convenience method for:

 for( PropertyInfo p : getProperties() ) {
   if(p.getName().equals(name))
     return p;
 }
 return null;
 

Returns: null if the property was not found.

See Also: getName

hasAttributeWildcard

public boolean hasAttributeWildcard()
Returns true if this bean class has an attribute wildcard.

This is true if the class declares an attribute wildcard, or it is inherited from its super classes.

See Also: inheritsAttributeWildcard

hasProperties

public boolean hasProperties()
If the class has properties, return true. This is only true if the Collection object returned by getProperties is not empty.

hasSubClasses

public boolean hasSubClasses()
True if there's a known sub-type of this class in TypeInfoSet.

hasValueProperty

public boolean hasValueProperty()
Returns true if this class or its ancestor has XmlValue property.

inheritsAttributeWildcard

public boolean inheritsAttributeWildcard()
Returns true iff this class inherits a wildcard attribute from its ancestor classes.

isAbstract

public boolean isAbstract()
If this class is abstract and thus shall never be directly instanciated.

isFinal

public boolean isFinal()
If this class is marked as final and no further extension/restriction is allowed.

isOrdered

public boolean isOrdered()
Returns true if the properties of this class is ordered in XML. False if it't not.

In RELAX NG context, ordered properties mean <group> and unordered properties mean <interleave>.