com.sun.tools.xjc.api.Property Maven / Gradle / Ivy
Show all versions of jaxb-xjc 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.tools.xjc.api;
import javax.xml.namespace.QName;
import com.sun.codemodel.JType;
/**
* Represents a property of a wrapper-style element.
*
*
* Carrys information about one property of a wrapper-style
* element. This interface is solely intended for the use by
* the JAX-RPC and otherwise the use is discouraged.
*
*
* REVISIT: use CodeModel.
*
* @author
* Kohsuke Kawaguchi ([email protected])
* @see Mapping
*/
public interface Property {
/**
* The name of the property.
*
*
* This method returns a valid identifier suitable for
* the use as a variable name.
*
* @return
* always non-null. Camel-style name like "foo" or "barAndZot".
* Note that it may contain non-ASCII characters (CJK, etc.)
* The caller is responsible for proper escaping if it
* wants to print this as a variable name.
*/
String name();
/**
* The Java type of the property.
*
* @return
* always non-null.
* {@link JType} is a representation of a Java type in a codeModel.
* If you just need the fully-qualified class name, call {@link JType#fullName()}.
*/
JType type();
/**
* Name of the XML element that corresponds to the property.
*
*
* Each child of a wrapper style element corresponds with an
* element, and this method returns that name.
*
* @return
* always non-null valid {@link QName}.
*/
QName elementName();
QName rawName();
}