/*
 * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package com.sun.tools.internal.xjc.outline;

import com.sun.codemodel.internal.JExpression;
import com.sun.codemodel.internal.JType;
import com.sun.tools.internal.xjc.model.CPropertyInfo;

Representation of a field of ClassOutline. 
Author:

    Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)/**
 * Representation of a field of {@link ClassOutline}.
 *
 * @author
 *     Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
 */
public interface FieldOutline {

    
Gets the enclosing ClassOutline. /**
     * Gets the enclosing {@link ClassOutline}.
     */
    ClassOutline parent();

    
Gets the corresponding model object. /** Gets the corresponding model object. */
    CPropertyInfo getPropertyInfo();

    
Gets the type of the "raw value".

This type can represent the entire value of this field.
For fields that can carry multiple values, this is an array.

This type allows the client of the outline to generate code
to set/get values from a property.
/**
     * Gets the type of the "raw value".
     *
     * <p>
     * This type can represent the entire value of this field.
     * For fields that can carry multiple values, this is an array.
     *
     * <p>
     * This type allows the client of the outline to generate code
     * to set/get values from a property.
     */
    JType getRawType();

    
Creates a new FieldAccessor of this field for the specified object. 
Params:
targetObject – 
     Evaluates to an object, and the field on this object
     will be accessed./**
     * Creates a new {@link FieldAccessor} of this field
     * for the specified object.
     *
     * @param targetObject
     *      Evaluates to an object, and the field on this object
     *      will be accessed.
     */
    FieldAccessor create( JExpression targetObject );
}