001: /*
002: * Copyright 2006 Sun Microsystems, Inc. All Rights Reserved.
003: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004: *
005: * This code is free software; you can redistribute it and/or modify it
006: * under the terms of the GNU General Public License version 2 only, as
007: * published by the Free Software Foundation. Sun designates this
008: * particular file as subject to the "Classpath" exception as provided
009: * by Sun in the LICENSE file that accompanied this code.
010: *
011: * This code is distributed in the hope that it will be useful, but WITHOUT
012: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014: * version 2 for more details (a copy is included in the LICENSE file that
015: * accompanied this code).
016: *
017: * You should have received a copy of the GNU General Public License version
018: * 2 along with this work; if not, write to the Free Software Foundation,
019: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020: *
021: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022: * CA 95054 USA or visit www.sun.com if you need additional information or
023: * have any questions.
024: */
025:
026: package com.sun.xml.internal.bind.v2.model.core;
027:
028: import java.util.Map;
029:
030: import javax.xml.namespace.QName;
031:
032: /**
033: * Property that maps to the following schema fragment.
034: *
035: * <pre><xmp>
036: * <xs:complexType>
037: * <xs:sequence>
038: * <xs:element name="entry" minOccurs="0" maxOccurs="unbounded">
039: * <xs:complexType>
040: * <xs:sequence>
041: * <xs:element name="key" type="XXXX"/>
042: * <xs:element name="value" type="YYYY"/>
043: * </xs:sequence>
044: * </xs:complexType>
045: * </xs:element>
046: * </xs:sequence>
047: * </xs:complexType>
048: * </xmp></pre>
049: *
050: * <p>
051: * This property is used to represent a default binding of a {@link Map} property.
052: * ({@link Map} properties with adapters will be represented by {@link ElementPropertyInfo}.)
053: *
054: *
055: * <h2>Design Thinking Led to This</h2>
056: * <p>
057: * I didn't like the idea of adding such a special-purpose {@link PropertyInfo} to a model.
058: * The alternative was to implicitly assume an adapter, and have internal representation of
059: * the Entry class ready.
060: * But the fact that the key type and the value type changes with the parameterization makes
061: * it very difficult to have such a class (especially inside APT, where we can't even generate
062: * classes.)
063: *
064: * @author Kohsuke Kawaguchi
065: */
066: public interface MapPropertyInfo<T, C> extends PropertyInfo<T, C> {
067: /**
068: * Gets the wrapper element name.
069: *
070: * @return
071: * always non-null.
072: */
073: QName getXmlName();
074:
075: /**
076: * Returns true if this property is nillable
077: * (meaning the absence of the value is treated as nil='true')
078: *
079: * <p>
080: * This method is only used when this property is a collection.
081: */
082: boolean isCollectionNillable();
083:
084: /**
085: * Type of the key of the map. K of {@code HashMap<K,V>}
086: *
087: * @return never null.
088: */
089: NonElement<T, C> getKeyType();
090:
091: /**
092: * Type of the value of the map. V of {@code HashMap<K,V>}
093: *
094: * @return never null.
095: */
096: NonElement<T, C> getValueType();
097:
098: // TODO
099: // Adapter<T,C> getKeyAdapter();
100: // Adapter<T,C> getValueAdapter();
101: }
|