/* * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved. * 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.Collection; import javax.activation.MimeType; import javax.xml.bind.annotation.XmlID; import javax.xml.bind.annotation.XmlIDREF; import javax.xml.bind.annotation.XmlType; import javax.xml.bind.annotation.XmlSchemaType; import javax.xml.namespace.QName; import com.sun.istack.internal.Nullable; import com.sun.xml.internal.bind.v2.model.annotation.AnnotationSource; /** * Information about a JAXB-bound property. * *
* All the JAXB annotations are already incorporated into the model so that
* the caller doesn't have to worry about reading them. For this reason, you
* cannot access annotations on properties directly.
*
* TODO: don't we need a visitor?
*
* @author Kohsuke Kawaguchi
*/
public interface PropertyInfo
* For example, "foo" or "bar".
* Generally, a property name is different from XML,
* (although they are often related, as a property name is often
* computed from tag names / attribute names.)
* In fact, property names do not directly affect XML.
* The property name uniquely identifies a property within a class.
*
* @see XmlType#propOrder()
*/
String getName();
/**
* Gets the display name of the property.
*
*
* This is a convenience method for
* {@code parent().getName()+'#'+getName()}.
*/
String displayName();
/**
* Returns true if this is a multi-valued collection property.
* Otherwise false, in which case the property is a single value.
*/
boolean isCollection();
/**
* List of {@link TypeInfo}s that this property references.
*
* This allows the caller to traverse the reference graph without
* getting into the details of each different property type.
*
* @return
* non-null read-only collection.
*/
Collection extends TypeInfo
* If the property doesn't have {@link XmlSchemaType} annotation,
* this method returns null.
*
*
* Since a type name is a property of a Java type, not a Java property,
* A schema type name of a Java type should be primarily obtained
* by using {@link NonElement#getTypeName()}. This method is to correctly
* implement the ugly semantics of {@link XmlSchemaType} (namely
* when this returns non-null, it overrides the type names of all types
* that are in this property.)
*/
@Nullable QName getSchemaType();
}