01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common Development
08: * and Distribution License("CDDL") (collectively, the "License"). You
09: * may not use this file except in compliance with the License. You can obtain
10: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12: * language governing permissions and limitations under the License.
13: *
14: * When distributing the software, include this License Header Notice in each
15: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16: * Sun designates this particular file as subject to the "Classpath" exception
17: * as provided by Sun in the GPL Version 2 section of the License file that
18: * accompanied this code. If applicable, add the following below the License
19: * Header, with the fields enclosed by brackets [] replaced by your own
20: * identifying information: "Portions Copyrighted [year]
21: * [name of copyright owner]"
22: *
23: * Contributor(s):
24: *
25: * If you wish your version of this file to be governed by only the CDDL or
26: * only the GPL Version 2, indicate your decision by adding "[Contributor]
27: * elects to include this software in this distribution under the [CDDL or GPL
28: * Version 2] license." If you don't indicate a single choice of license, a
29: * recipient has the option to distribute your version of this file under
30: * either the CDDL, the GPL Version 2 or to extend the choice of license to
31: * its licensees as provided above. However, if you add GPL Version 2 code
32: * and therefore, elected the GPL Version 2 license, then the option applies
33: * only if the new code is made subject to such option by the copyright
34: * holder.
35: */
36: package com.sun.tools.xjc.api;
37:
38: import javax.xml.namespace.QName;
39:
40: import com.sun.codemodel.JType;
41:
42: /**
43: * Represents a property of a wrapper-style element.
44: *
45: * <p>
46: * Carrys information about one property of a wrapper-style
47: * element. This interface is solely intended for the use by
48: * the JAX-RPC and otherwise the use is discouraged.
49: *
50: * <p>
51: * REVISIT: use CodeModel.
52: *
53: * @author
54: * Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
55: * @see Mapping
56: */
57: public interface Property {
58: /**
59: * The name of the property.
60: *
61: * <p>
62: * This method returns a valid identifier suitable for
63: * the use as a variable name.
64: *
65: * @return
66: * always non-null. Camel-style name like "foo" or "barAndZot".
67: * Note that it may contain non-ASCII characters (CJK, etc.)
68: * The caller is responsible for proper escaping if it
69: * wants to print this as a variable name.
70: */
71: String name();
72:
73: /**
74: * The Java type of the property.
75: *
76: * @return
77: * always non-null.
78: * {@link JType} is a representation of a Java type in a codeModel.
79: * If you just need the fully-qualified class name, call {@link JType#fullName()}.
80: */
81: JType type();
82:
83: /**
84: * Name of the XML element that corresponds to the property.
85: *
86: * <p>
87: * Each child of a wrapper style element corresponds with an
88: * element, and this method returns that name.
89: *
90: * @return
91: * always non-null valid {@link QName}.
92: */
93: QName elementName();
94: }
|