View Javadoc
1   /*
2    * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
3    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4    *
5    * This code is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU General Public License version 2 only, as
7    * published by the Free Software Foundation.  Oracle designates this
8    * particular file as subject to the "Classpath" exception as provided
9    * by Oracle in the LICENSE file that accompanied this code.
10   *
11   * This code is distributed in the hope that it will be useful, but WITHOUT
12   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13   * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14   * version 2 for more details (a copy is included in the LICENSE file that
15   * accompanied this code).
16   *
17   * You should have received a copy of the GNU General Public License version
18   * 2 along with this work; if not, write to the Free Software Foundation,
19   * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20   *
21   * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22   * or visit www.oracle.com if you need additional information or have any
23   * questions.
24   */
25  
26  package com.sun.tools.internal.xjc.outline;
27  
28  import com.sun.codemodel.internal.JExpression;
29  import com.sun.codemodel.internal.JType;
30  import com.sun.tools.internal.xjc.model.CPropertyInfo;
31  
32  /**
33   * Representation of a field of {@link ClassOutline}.
34   *
35   * @author
36   *     Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
37   */
38  public interface FieldOutline {
39  
40      /**
41       * Gets the enclosing {@link ClassOutline}.
42       */
43      ClassOutline parent();
44  
45      /** Gets the corresponding model object. */
46      CPropertyInfo getPropertyInfo();
47  
48      /**
49       * Gets the type of the "raw value".
50       *
51       * <p>
52       * This type can represent the entire value of this field.
53       * For fields that can carry multiple values, this is an array.
54       *
55       * <p>
56       * This type allows the client of the outline to generate code
57       * to set/get values from a property.
58       */
59      JType getRawType();
60  
61      /**
62       * Creates a new {@link FieldAccessor} of this field
63       * for the specified object.
64       *
65       * @param targetObject
66       *      Evaluates to an object, and the field on this object
67       *      will be accessed.
68       */
69      FieldAccessor create( JExpression targetObject );
70  }