001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common Development
008: * and Distribution License("CDDL") (collectively, the "License"). You
009: * may not use this file except in compliance with the License. You can obtain
010: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
011: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
012: * language governing permissions and limitations under the License.
013: *
014: * When distributing the software, include this License Header Notice in each
015: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
016: * Sun designates this particular file as subject to the "Classpath" exception
017: * as provided by Sun in the GPL Version 2 section of the License file that
018: * accompanied this code. If applicable, add the following below the License
019: * Header, with the fields enclosed by brackets [] replaced by your own
020: * identifying information: "Portions Copyrighted [year]
021: * [name of copyright owner]"
022: *
023: * Contributor(s):
024: *
025: * If you wish your version of this file to be governed by only the CDDL or
026: * only the GPL Version 2, indicate your decision by adding "[Contributor]
027: * elects to include this software in this distribution under the [CDDL or GPL
028: * Version 2] license." If you don't indicate a single choice of license, a
029: * recipient has the option to distribute your version of this file under
030: * either the CDDL, the GPL Version 2 or to extend the choice of license to
031: * its licensees as provided above. However, if you add GPL Version 2 code
032: * and therefore, elected the GPL Version 2 license, then the option applies
033: * only if the new code is made subject to such option by the copyright
034: * holder.
035: */
036:
037: package com.sun.xml.bind.v2.model.core;
038:
039: import java.util.Map;
040:
041: import javax.xml.namespace.QName;
042:
043: /**
044: * Property that maps to the following schema fragment.
045: *
046: * <pre><xmp>
047: * <xs:complexType>
048: * <xs:sequence>
049: * <xs:element name="entry" minOccurs="0" maxOccurs="unbounded">
050: * <xs:complexType>
051: * <xs:sequence>
052: * <xs:element name="key" type="XXXX"/>
053: * <xs:element name="value" type="YYYY"/>
054: * </xs:sequence>
055: * </xs:complexType>
056: * </xs:element>
057: * </xs:sequence>
058: * </xs:complexType>
059: * </xmp></pre>
060: *
061: * <p>
062: * This property is used to represent a default binding of a {@link Map} property.
063: * ({@link Map} properties with adapters will be represented by {@link ElementPropertyInfo}.)
064: *
065: *
066: * <h2>Design Thinking Led to This</h2>
067: * <p>
068: * I didn't like the idea of adding such a special-purpose {@link PropertyInfo} to a model.
069: * The alternative was to implicitly assume an adapter, and have internal representation of
070: * the Entry class ready.
071: * But the fact that the key type and the value type changes with the parameterization makes
072: * it very difficult to have such a class (especially inside APT, where we can't even generate
073: * classes.)
074: *
075: * @author Kohsuke Kawaguchi
076: */
077: public interface MapPropertyInfo<T, C> extends PropertyInfo<T, C> {
078: /**
079: * Gets the wrapper element name.
080: *
081: * @return
082: * always non-null.
083: */
084: QName getXmlName();
085:
086: /**
087: * Returns true if this property is nillable
088: * (meaning the absence of the value is treated as nil='true')
089: *
090: * <p>
091: * This method is only used when this property is a collection.
092: */
093: boolean isCollectionNillable();
094:
095: /**
096: * Type of the key of the map. K of {@code HashMap<K,V>}
097: *
098: * @return never null.
099: */
100: NonElement<T, C> getKeyType();
101:
102: /**
103: * Type of the value of the map. V of {@code HashMap<K,V>}
104: *
105: * @return never null.
106: */
107: NonElement<T, C> getValueType();
108:
109: // TODO
110: // Adapter<T,C> getKeyAdapter();
111: // Adapter<T,C> getValueAdapter();
112: }
|