/*
 * Copyright 2002-2017 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.core.type;

import org.springframework.lang.Nullable;

Interface that defines abstract metadata of a specific class,
in a form that does not require that class to be loaded yet.
Author:
Juergen Hoeller
See Also:
StandardClassMetadata
MetadataReader.getClassMetadata()
AnnotationMetadata
Since:
2.5/**
 * Interface that defines abstract metadata of a specific class,
 * in a form that does not require that class to be loaded yet.
 *
 * @author Juergen Hoeller
 * @since 2.5
 * @see StandardClassMetadata
 * @see org.springframework.core.type.classreading.MetadataReader#getClassMetadata()
 * @see AnnotationMetadata
 */
public interface ClassMetadata {

	
Return the name of the underlying class.
/**
	 * Return the name of the underlying class.
	 */
	String getClassName();

	
Return whether the underlying class represents an interface.
/**
	 * Return whether the underlying class represents an interface.
	 */
	boolean isInterface();

	
Return whether the underlying class represents an annotation.
Since:
4.1/**
	 * Return whether the underlying class represents an annotation.
	 * @since 4.1
	 */
	boolean isAnnotation();

	
Return whether the underlying class is marked as abstract.
/**
	 * Return whether the underlying class is marked as abstract.
	 */
	boolean isAbstract();

	
Return whether the underlying class represents a concrete class,
i.e. neither an interface nor an abstract class.
/**
	 * Return whether the underlying class represents a concrete class,
	 * i.e. neither an interface nor an abstract class.
	 */
	boolean isConcrete();

	
Return whether the underlying class is marked as 'final'.
/**
	 * Return whether the underlying class is marked as 'final'.
	 */
	boolean isFinal();

	
Determine whether the underlying class is independent, i.e. whether
it is a top-level class or a nested class (static inner class) that
can be constructed independently from an enclosing class.
/**
	 * Determine whether the underlying class is independent, i.e. whether
	 * it is a top-level class or a nested class (static inner class) that
	 * can be constructed independently from an enclosing class.
	 */
	boolean isIndependent();

	
Return whether the underlying class is declared within an enclosing
class (i.e. the underlying class is an inner/nested class or a
local class within a method).
If this method returns false, then the underlying class is a top-level class. /**
	 * Return whether the underlying class is declared within an enclosing
	 * class (i.e. the underlying class is an inner/nested class or a
	 * local class within a method).
	 * <p>If this method returns {@code false}, then the underlying
	 * class is a top-level class.
	 */
	boolean hasEnclosingClass();

	
Return the name of the enclosing class of the underlying class, or null if the underlying class is a top-level class. /**
	 * Return the name of the enclosing class of the underlying class,
	 * or {@code null} if the underlying class is a top-level class.
	 */
	@Nullable
	String getEnclosingClassName();

	
Return whether the underlying class has a super class.
/**
	 * Return whether the underlying class has a super class.
	 */
	boolean hasSuperClass();

	
Return the name of the super class of the underlying class, or null if there is no super class defined. /**
	 * Return the name of the super class of the underlying class,
	 * or {@code null} if there is no super class defined.
	 */
	@Nullable
	String getSuperClassName();

	
Return the names of all interfaces that the underlying class
implements, or an empty array if there are none.
/**
	 * Return the names of all interfaces that the underlying class
	 * implements, or an empty array if there are none.
	 */
	String[] getInterfaceNames();

	
Return the names of all classes declared as members of the class represented by
this ClassMetadata object. This includes public, protected, default (package)
access, and private classes and interfaces declared by the class, but excludes
inherited classes and interfaces. An empty array is returned if no member classes
or interfaces exist.
Since:
3.1/**
	 * Return the names of all classes declared as members of the class represented by
	 * this ClassMetadata object. This includes public, protected, default (package)
	 * access, and private classes and interfaces declared by the class, but excludes
	 * inherited classes and interfaces. An empty array is returned if no member classes
	 * or interfaces exist.
	 * @since 3.1
	 */
	String[] getMemberClassNames();

}