325N/A/*
325N/A * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
325N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
325N/A *
325N/A * This code is free software; you can redistribute it and/or modify it
325N/A * under the terms of the GNU General Public License version 2 only, as
325N/A * published by the Free Software Foundation. Oracle designates this
325N/A * particular file as subject to the "Classpath" exception as provided
325N/A * by Oracle in the LICENSE file that accompanied this code.
325N/A *
325N/A * This code is distributed in the hope that it will be useful, but WITHOUT
325N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
325N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
325N/A * version 2 for more details (a copy is included in the LICENSE file that
325N/A * accompanied this code).
325N/A *
325N/A * You should have received a copy of the GNU General Public License version
325N/A * 2 along with this work; if not, write to the Free Software Foundation,
325N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
325N/A *
325N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
325N/A * or visit www.oracle.com if you need additional information or have any
325N/A * questions.
325N/A */
325N/A
325N/Apackage com.sun.xml.internal.bind.v2.model.core;
325N/A
325N/Aimport java.util.Map;
325N/A
325N/Aimport javax.xml.namespace.QName;
325N/A
325N/A/**
325N/A * Property that maps to the following schema fragment.
325N/A *
325N/A * <pre><xmp>
325N/A * <xs:complexType>
325N/A * <xs:sequence>
325N/A * <xs:element name="entry" minOccurs="0" maxOccurs="unbounded">
325N/A * <xs:complexType>
325N/A * <xs:sequence>
325N/A * <xs:element name="key" type="XXXX"/>
325N/A * <xs:element name="value" type="YYYY"/>
325N/A * </xs:sequence>
325N/A * </xs:complexType>
325N/A * </xs:element>
325N/A * </xs:sequence>
325N/A * </xs:complexType>
325N/A * </xmp></pre>
325N/A *
325N/A * <p>
325N/A * This property is used to represent a default binding of a {@link Map} property.
325N/A * ({@link Map} properties with adapters will be represented by {@link ElementPropertyInfo}.)
325N/A *
325N/A *
325N/A * <h2>Design Thinking Led to This</h2>
325N/A * <p>
325N/A * I didn't like the idea of adding such a special-purpose {@link PropertyInfo} to a model.
325N/A * The alternative was to implicitly assume an adapter, and have internal representation of
325N/A * the Entry class ready.
325N/A * But the fact that the key type and the value type changes with the parameterization makes
325N/A * it very difficult to have such a class (especially inside APT, where we can't even generate
325N/A * classes.)
325N/A *
325N/A * @author Kohsuke Kawaguchi
325N/A */
325N/Apublic interface MapPropertyInfo<T,C> extends PropertyInfo<T,C> {
325N/A /**
325N/A * Gets the wrapper element name.
325N/A *
325N/A * @return
325N/A * always non-null.
325N/A */
325N/A QName getXmlName();
325N/A
325N/A /**
325N/A * Returns true if this property is nillable
325N/A * (meaning the absence of the value is treated as nil='true')
325N/A *
325N/A * <p>
325N/A * This method is only used when this property is a collection.
325N/A */
325N/A boolean isCollectionNillable();
325N/A
325N/A /**
325N/A * Type of the key of the map. K of {@code HashMap<K,V>}
325N/A *
325N/A * @return never null.
325N/A */
325N/A NonElement<T,C> getKeyType();
325N/A
325N/A /**
325N/A * Type of the value of the map. V of {@code HashMap<K,V>}
325N/A *
325N/A * @return never null.
325N/A */
325N/A NonElement<T,C> getValueType();
325N/A
325N/A // TODO
325N/A // Adapter<T,C> getKeyAdapter();
325N/A // Adapter<T,C> getValueAdapter();
325N/A}