/*
* Copyright (c) 2005, 2014, 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.openjdk.jmh.generators.core;
import java.lang.annotation.Annotation;
Field metadata info.
/**
* Field metadata info.
*/
public interface FieldInfo extends MetadataInfo {
Returns: field name
/**
* @return field name
*/
String getName();
Returns: fully qualified field type
/**
* @return fully qualified field type
*/
ClassInfo getType();
Returns: reference to syntactically-enclosing class
/**
* @return reference to syntactically-enclosing class
*/
ClassInfo getDeclaringClass();
Params: - annClass – annotation class
Type parameters: - <T> – annotation type
Returns: field-level annotation, if any; null otherwise
/**
* @param annClass annotation class
* @param <T> annotation type
* @return field-level annotation, if any; null otherwise
*/
<T extends Annotation> T getAnnotation(Class<T> annClass);
Returns: true, if field is public
/**
* @return true, if field is public
*/
boolean isPublic();
Returns: true, if field is static
/**
* @return true, if field is static
*/
boolean isStatic();
Returns: true, if field is final
/**
* @return true, if field is final
*/
boolean isFinal();
}