/*
* 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;
import java.util.Collection;
Class metadata.
/**
* Class metadata.
*/
public interface ClassInfo extends MetadataInfo {
Returns: fully qualified package name
/**
* @return fully qualified package name
*/
String getPackageName();
Returns: fully qualified class name
/**
*
* @return fully qualified class name
*/
String getQualifiedName();
Returns: short class name
/**
* @return short class name
*/
String getName();
Returns: reference to super-class metadata
/**
* @return reference to super-class metadata
*/
ClassInfo getSuperClass();
Returns: reference to syntactically-enclosing class
/**
* @return reference to syntactically-enclosing class
*/
ClassInfo getDeclaringClass();
Returns: collection of all fields in class
/**
* @return collection of all fields in class
*/
Collection<FieldInfo> getFields();
Returns: collection of all methods in class
/**
* @return collection of all methods in class
*/
Collection<MethodInfo> getMethods();
Returns: collection of all constructors in class
/**
* @return collection of all constructors in class
*/
Collection<MethodInfo> getConstructors();
Params: - annClass – annotation class
Type parameters: - <T> – annotation type
Returns: class-level annotation, if any; null otherwise
/**
* @param annClass annotation class
* @param <T> annotation type
* @return class-level annotation, if any; null otherwise
*/
<T extends Annotation> T getAnnotation(Class<T> annClass);
Returns: true, if class is abstract
/**
* @return true, if class is abstract
*/
boolean isAbstract();
Returns: true, if class is abstract
/**
* @return true, if class is abstract
*/
boolean isPublic();
Returns: true, if class is strictfp
/**
* @return true, if class is strictfp
*/
boolean isStrictFP();
Returns: true, if class is final
/**
* @return true, if class is final
*/
boolean isFinal();
Returns: true, if class is inner
/**
* @return true, if class is inner
*/
boolean isInner();
Returns: true, if class is enum
/**
* @return true, if class is enum
*/
boolean isEnum();
Returns: if class is enum, the collection of its constant values;
empty collection otherwise
/**
* @return if class is enum, the collection of its constant values;
* empty collection otherwise
*/
Collection<String> getEnumConstants();
}