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.Collection;
040:
041: import javax.activation.MimeType;
042: import javax.xml.bind.annotation.XmlID;
043: import javax.xml.bind.annotation.XmlIDREF;
044: import javax.xml.bind.annotation.XmlType;
045: import javax.xml.bind.annotation.XmlSchemaType;
046: import javax.xml.namespace.QName;
047:
048: import com.sun.istack.Nullable;
049: import com.sun.xml.bind.v2.model.annotation.AnnotationSource;
050:
051: /**
052: * Information about a JAXB-bound property.
053: *
054: * <p>
055: * All the JAXB annotations are already incorporated into the model so that
056: * the caller doesn't have to worry about reading them. For this reason, you
057: * cannot access annotations on properties directly.
058: *
059: * TODO: don't we need a visitor?
060: *
061: * @author Kohsuke Kawaguchi
062: */
063: public interface PropertyInfo<T, C> extends AnnotationSource {
064:
065: /**
066: * Gets the {@link ClassInfo} or {@link ElementInfo} to which this property belongs.
067: */
068: TypeInfo<T, C> parent();
069:
070: /**
071: * Gets the name of the property.
072: *
073: * <p>
074: * For example, "foo" or "bar".
075: * Generally, a property name is different from XML,
076: * (although they are often related, as a property name is often
077: * computed from tag names / attribute names.)
078: * In fact, <b>property names do not directly affect XML</b>.
079: * The property name uniquely identifies a property within a class.
080: *
081: * @see XmlType#propOrder()
082: */
083: String getName();
084:
085: /**
086: * Gets the display name of the property.
087: *
088: * <p>
089: * This is a convenience method for
090: * {@code parent().getName()+'#'+getName()}.
091: */
092: String displayName();
093:
094: /**
095: * Returns true if this is a multi-valued collection property.
096: * Otherwise false, in which case the property is a single value.
097: */
098: boolean isCollection();
099:
100: /**
101: * List of {@link TypeInfo}s that this property references.
102: *
103: * This allows the caller to traverse the reference graph without
104: * getting into the details of each different property type.
105: *
106: * @return
107: * non-null read-only collection.
108: */
109: Collection<? extends TypeInfo<T, C>> ref();
110:
111: /**
112: * Gets the kind of this proeprty.
113: *
114: * @return
115: * always non-null.
116: */
117: PropertyKind kind();
118:
119: /**
120: * @return
121: * null if the property is not adapted.
122: */
123: Adapter<T, C> getAdapter();
124:
125: /**
126: * Returns the IDness of the value of this element.
127: *
128: * @see XmlID
129: * @see XmlIDREF
130: *
131: * @return
132: * always non-null
133: */
134: ID id();
135:
136: /**
137: * Expected MIME type, if any.
138: */
139: MimeType getExpectedMimeType();
140:
141: /**
142: * If this is true and this property indeed represents a binary data,
143: * it should be always inlined.
144: */
145: boolean inlineBinaryData();
146:
147: /**
148: * The effective value of {@link XmlSchemaType} annotation, if any.
149: *
150: * <p>
151: * If the property doesn't have {@link XmlSchemaType} annotation,
152: * this method returns null.
153: *
154: * <p>
155: * Since a type name is a property of a Java type, not a Java property,
156: * A schema type name of a Java type should be primarily obtained
157: * by using {@link NonElement#getTypeName()}. This method is to correctly
158: * implement the ugly semantics of {@link XmlSchemaType} (namely
159: * when this returns non-null, it overrides the type names of all types
160: * that are in this property.)
161: */
162: @Nullable
163: QName getSchemaType();
164: }
|