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

Interface MapPropertyInfo<T,C>

public interface MapPropertyInfo<T,C> extends PropertyInfo<T,C>

Property that maps to the following schema fragment.

 <xs:complexType>
   <xs:sequence>
     <xs:element name="entry" minOccurs="0" maxOccurs="unbounded">
       <xs:complexType>
         <xs:sequence>
           <xs:element name="key"   type="XXXX"/>
           <xs:element name="value" type="YYYY"/>
         </xs:sequence>
       </xs:complexType>
     </xs:element>
   </xs:sequence>
 </xs:complexType>
 

This property is used to represent a default binding of a Map property. (Map properties with adapters will be represented by ElementPropertyInfo.)

Design Thinking Led to This

I didn't like the idea of adding such a special-purpose PropertyInfo to a model. The alternative was to implicitly assume an adapter, and have internal representation of the Entry class ready. But the fact that the key type and the value type changes with the parameterization makes it very difficult to have such a class (especially inside APT, where we can't even generate classes.)

Method Summary
NonElement<T,C>getKeyType()
Type of the key of the map.
NonElement<T,C>getValueType()
Type of the value of the map.
QNamegetXmlName()
Gets the wrapper element name.
booleanisCollectionNillable()
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.

Method Detail

getKeyType

public NonElement<T,C> getKeyType()
Type of the key of the map. K of {@code HashMap}

Returns: never null.

getValueType

public NonElement<T,C> getValueType()
Type of the value of the map. V of {@code HashMap}

Returns: never null.

getXmlName

public QName getXmlName()
Gets the wrapper element name.

Returns: always non-null.

isCollectionNillable

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.