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.outline;
37:
38: import com.sun.codemodel.JExpression;
39: import com.sun.codemodel.JType;
40: import com.sun.tools.xjc.model.CPropertyInfo;
41:
42: /**
43: * Representation of a field of {@link ClassOutline}.
44: *
45: * @author
46: * Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
47: */
48: public interface FieldOutline {
49:
50: /**
51: * Gets the enclosing {@link ClassOutline}.
52: */
53: ClassOutline parent();
54:
55: /** Gets the corresponding model object. */
56: CPropertyInfo getPropertyInfo();
57:
58: /**
59: * Gets the type of the "raw value".
60: *
61: * <p>
62: * This type can represent the entire value of this field.
63: * For fields that can carry multiple values, this is an array.
64: *
65: * <p>
66: * This type allows the client of the outline to generate code
67: * to set/get values from a property.
68: */
69: JType getRawType();
70:
71: /**
72: * Creates a new {@link FieldAccessor} of this field
73: * for the specified object.
74: *
75: * @param targetObject
76: * Evaluates to an object, and the field on this object
77: * will be accessed.
78: */
79: FieldAccessor create(JExpression targetObject);
80: }
|