/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package com.sun.xml.internal.bind.v2.model.core;

import java.util.Map;

import javax.xml.namespace.QName;

/**

 * Property that maps to the following schema fragment.

 *

 * <pre><xmp>

 * <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>

 * </xmp></pre>

 *

 * <p>

 * This property is used to represent a default binding of a {@link Map} property.

 * ({@link Map} properties with adapters will be represented by {@link ElementPropertyInfo}.)

 *

 *

 * <h2>Design Thinking Led to This</h2>

 * <p>

 * I didn't like the idea of adding such a special-purpose {@link 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 Annotation Processing, where we can't even generate

 * classes.)

 *

 * @author Kohsuke Kawaguchi

 */

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

    /**

     * Gets the wrapper element name.

     *

     * @return

     *      always non-null.

     */

    QName getXmlName();

    /**

     * Returns true if this property is nillable

     * (meaning the absence of the value is treated as nil='true')

     *

     * <p>

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

     */

    boolean isCollectionNillable();

    /**

     * Type of the key of the map. K of {@code HashMap<K,V>}

     *

     * @return never null.

     */

    NonElement<T,C> getKeyType();

    /**

     * Type of the value of the map. V of {@code HashMap<K,V>}

     *

     * @return never null.

     */

    NonElement<T,C> getValueType();

    // TODO

    // Adapter<T,C> getKeyAdapter();

    // Adapter<T,C> getValueAdapter();

}