/*
 * Copyright (c) 1997, 2021, 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 org.graalvm.visualvm.lib.jfluid.heap;


/**
 * represents field (static or instance) of the class.
 * @author Tomas Hurka
 */
public interface Field {
    //~ Methods ------------------------------------------------------------------------------------------------------------------

    /**
     * returns declaring class for this field.
     * <br>
     * speed: fast
     * @return {@link JavaClass} where this field is declared
     */
    JavaClass getDeclaringClass();

    /**
     * returns name of the field.
     * <br>
     * speed: fast
     * @return name of the field
     */
    String getName();

    /**
     * distinguish between static and instance field.
     * <br>
     * speed: fast
     * @return returns <CODE>true</CODE> if the field is defined as static, <CODE>false</CODE> otherwise
     */
    boolean isStatic();

    /**
     * returns the type of field (object, int, boolean, etc.). Note that all java objects
     * have type "object", there is no difference between java.lang.String and java.util.List.
     * <br>
     * Speed: fast
     * @return type of field
     */
    Type getType();
}
