com.sun.xml.bind.v2.model.core.PropertyInfo Maven / Gradle / Ivy
Show all versions of jaxb-core Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2017 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://oss.oracle.com/licenses/CDDL+GPL-1.1
* or LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.xml.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.Nullable;
import com.sun.xml.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 extends AnnotationSource {
/**
* Gets the {@link ClassInfo} or {@link ElementInfo} to which this property belongs.
*/
TypeInfo parent();
/**
* Gets the name of the property.
*
*
* 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> ref();
/**
* Gets the kind of this property.
*
* @return
* always non-null.
*/
PropertyKind kind();
/**
* @return
* null if the property is not adapted.
*/
Adapter getAdapter();
/**
* Returns the IDness of the value of this element.
*
* @see XmlID
* @see XmlIDREF
*
* @return
* always non-null
*/
ID id();
/**
* Expected MIME type, if any.
*/
MimeType getExpectedMimeType();
/**
* If this is true and this property indeed represents a binary data,
* it should be always inlined.
*/
boolean inlineBinaryData();
/**
* The effective value of {@link XmlSchemaType} annotation, if any.
*
*
* 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();
}