com.thoughtworks.qdox.model.JavaClass Maven / Gradle / Ivy
package com.thoughtworks.qdox.model;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.
*/
import java.util.List;
import com.thoughtworks.qdox.library.ClassLibrary;
/**
* Equivalent of {@link java.lang.Class}, providing the most important methods.
* Where the original Class is using an Array, this model is using a List.
*
* @author Robert Scholte
*/
public interface JavaClass extends JavaModel, JavaType, JavaAnnotatedElement, JavaGenericDeclaration
{
/**
* The compilation unit, which includes the imports, the public and anonymous classes
*
* @return the {@link JavaSource} of this element
*/
JavaSource getSource();
/**
* (API description of {@link java.lang.Class#isInterface()})
*
* Determines if the specified Class object represents an interface type.
*
*
* @return true if this object represents an interface, otherwise false
*/
boolean isInterface();
/**
* (API description of {@link java.lang.Class#isEnum()})
*
* Returns true if and only if this class was declared as an enum in the source code.
*
*
* @return true if this object represents an enum, otherwise false
*/
boolean isEnum();
/**
* (API description of {@link java.lang.Class#isAnnotation()})
* Returns true if this Class object represents an annotation type.
* Note that if this method returns true, {@link #isInterface()} would also return true, as all annotation types are also interfaces.
*
*
* @return true if this object represents an annotation, otherwise false
* @since 2.0
*/
boolean isAnnotation();
JavaClass getDeclaringClass();
JavaType getSuperClass();
/**
* Shorthand for getSuperClass().getJavaClass() with null checking.
* @return the super class as {@link JavaClass}
*/
JavaClass getSuperJavaClass();
List getImplements();
/**
* Equivalent of {@link java.lang.Class#getInterfaces()}
* Determines the interfaces implemented by the class or interface represented by this object.
*
* @return a list of interfaces, never null
* @since 2.0
*/
List getInterfaces();
String getCodeBlock();
JavaSource getParentSource();
/**
* Equivalent of {@link java.lang.Class#getPackage()}
* @return the package
*/
JavaPackage getPackage();
/**
* If this class has a package, the packagename will be returned.
* Otherwise an empty String.
*
* @return the name of the package, otherwise an empty String
*/
String getPackageName();
/**
* @since 1.3
* @return true if this class is an inner class, otherwise false
*/
boolean isInner();
/**
* Equivalent of {@link java.lang.Class#getMethods()}
*
* @return the methods declared or overridden in this class
*/
List getMethods();
/**
* Equivalent of {@link java.lang.Class#getConstructors()}
*
* @return the list of constructors
* @since 2.0
*/
List getConstructors();
/**
*
* @param parameterTypes the parameter types of the constructor, can be null
* @return the matching constructor, otherwise null
* @since 2.0
*/
JavaConstructor getConstructor(List parameterTypes);
/**
*
* @param parameterTypes the parameter types of the constructor, can be null
* @param varArg define is the constructor has varArgs
* @return the matching constructor, otherwise null
* @since 2.0
*/
JavaConstructor getConstructor(List parameterTypes, boolean varArg);
/**
* Return declared methods and optionally the inherited methods
*
* @param superclasses {@code true} if inherited methods should be returned as well
* @return all methods
* @since 1.3
*/
List getMethods( boolean superclasses );
/**
*
* @param name the name of the method
* @param parameterTypes the parameter types of the method, can be null.
* @return the matching method, otherwise null
*/
JavaMethod getMethodBySignature( String name, List parameterTypes );
/**
* This should be the signature for getMethodBySignature.
*
* @param name the name of the method
* @param parameterTypes the parameter types of the method, can be {@code null}
* @param varArgs define if the method has varArgs
* @return the matching method, otherwise {@code null}
*/
JavaMethod getMethod( String name, List parameterTypes, boolean varArgs );
/**
*
* @param name the name of the method
* @param parameterTypes the parameter types of the method, can be {@code null}
* @param superclasses to define if superclasses should be included as well
* @return the matching method, otherwise {@code null}
*/
JavaMethod getMethodBySignature( String name, List parameterTypes, boolean superclasses );
/**
*
* @param name the name of the method
* @param parameterTypes the parameter types of the method, can be {@code null}
* @param superclasses {@code true} if inherited methods should be matched as well
* @param varArg define if the method has varArgs
* @return the matching method, otherwise {@code null}
*/
JavaMethod getMethodBySignature( String name, List parameterTypes, boolean superclasses, boolean varArg );
/**
*
* @param name the name of the method
* @param parameterTypes the parameter types of the method, can be {@code null}
* @param superclasses {@code true} if inherited methods should be matched as well
* @return the matching methods, otherwise {@code null}
*/
List getMethodsBySignature( String name, List parameterTypes, boolean superclasses );
/**
*
* @param name the name of the method
* @param parameterTypes the parameter types of the method, can be {@code null}
* @param superclasses {@code true} if inherited methods should be matched as well
* @param varArg define if the method has varArgs
* @return the matching methods, otherwise {@code null}
*/
List getMethodsBySignature( String name, List parameterTypes, boolean superclasses,
boolean varArg );
/**
* Equivalent of {@link java.lang.Class#getFields()}
*
* @return a list of fiels, never {@code null}
*/
List getFields();
/**
* Equivalent of {@link java.lang.Class#getField(String)}, where this method can resolve every field
*
* @param name the name of the field
* @return the field
*/
JavaField getFieldByName( String name );
/**
* Based on {@link java.lang.Class#getEnumConstants()}.
*
*
* @return a List of enum constants if this class is an enum, otherwise {@code null}
*/
List getEnumConstants();
/**
*
* @param name the name of the enum constant
* @return the enumConstant matching the {@code name}, otherwise null
*/
JavaField getEnumConstantByName( String name );
/**
* Equivalent of {@link Class#getDeclaredClasses()}
*
* @return a list of declared classes, never null
* @since 1.3
*/
List getNestedClasses();
JavaClass getNestedClassByName( String name );
/**
* @param fullyQualifiedName the FQN to match with
* @return {@code true} if this is of type FQN, otherwise {@code false}
* @since 1.3
*/
boolean isA( String fullyQualifiedName );
/**
* @param javaClass the JavaClass to match with
* @return {@code true} if this is of type {@literal javaClass}, otherwise {@code false}
* @since 1.3
*/
boolean isA( JavaClass javaClass );
/**
* Returns the depth of this array, 0 if it's not an array
*
* @return The depth of this array, at least 0
* @since 2.0
*/
int getDimensions();
/**
*
* @return true if this JavaClass is an array, otherwise false
* @since 2.0
*/
boolean isArray();
/**
*
* @return true if this JavaClass is a void, otherwise false
* @since 2.0 (was part of Type since 1.6)
*/
boolean isVoid();
/**
* Equivalent of {@link Class#getComponentType()}
* If this type is an array, return its component type
*
* @return the type of array if it's one, otherwise null
*/
JavaClass getComponentType();
/**
* Gets bean properties without looking in superclasses or interfaces.
*
* @return the bean properties
* @since 1.3
*/
List getBeanProperties();
/**
*
* @param superclasses to define if superclasses should be included as well
* @return the bean properties
* @since 1.3
*/
List getBeanProperties( boolean superclasses );
/**
* Gets bean property without looking in superclasses or interfaces.
*
* @param propertyName the name of the property
* @return the bean property
* @since 1.3
*/
BeanProperty getBeanProperty( String propertyName );
/**
* @param propertyName the name of the property
* @param superclasses to define if superclasses should be included as well
* @return the bean property
* @since 1.3
*/
BeanProperty getBeanProperty( String propertyName, boolean superclasses );
/**
* Equivalent of {@link Class#getClasses()}
* Gets the known derived classes. That is, subclasses or implementing classes.
* @return the derived classes
*/
List getDerivedClasses();
List getTagsByName( String name, boolean superclasses );
ClassLibrary getJavaClassLibrary();
/**
* A list if {@link JavaInitializer}, either static or instance initializers.
*
* @return a List of initializers
*/
List getInitializers();
/**
* Equivalent of {@link java.lang.Class#getName()}.
*
* @return the name of the entity (class, interface, array class, primitive type, or void) represented by this Class object, as a String.
*/
String getName();
/**
* Equivalent of {@link java.lang.Class#getSimpleName()}.
*
* @return the simple name of the underlying class as given in the source code.
* @since 2.0
*/
String getSimpleName();
/**
* Equivalent of {@link Class#getModifiers()}
*
* This does not follow the java-api
* The Class.getModifiers() returns an int, which should be decoded with the {@link java.lang.reflect.Modifier}.
* This method will return a list of strings representing the modifiers.
* If this member was extracted from a source, it will keep its order.
* Otherwise if will be in the preferred order of the java-api.
*
* @return all modifiers is this member
*/
List getModifiers();
/**
* (API description of {@link java.lang.reflect.Modifier#isPublic(int)})
*
* Return true if the class includes the public modifier, false otherwise.
*
*
* @return true if class has the public modifier, otherwise false
*/
boolean isPublic();
/**
* (API description of {@link java.lang.reflect.Modifier#isProtected(int)})
*
* Return true if the class includes the protected modifier, false otherwise.
*
*
* @return true if class has the protected modifier, otherwise false
*/
boolean isProtected();
/**
* (API description of {@link java.lang.reflect.Modifier#isPrivate(int)})
*
* Return true if the class includes the private modifier, false otherwise.
*
*
* @return true if class has the private modifier, otherwise false
*/
boolean isPrivate();
/**
* (API description of {@link java.lang.reflect.Modifier#isFinal(int)})
*
* Return true if the class includes the final modifier, false otherwise.
*
*
* @return true if class has the final modifier, otherwise false
*/
boolean isFinal();
/**
* (API description of {@link java.lang.reflect.Modifier#isStatic(int)})
*
* Return true if the class includes the static modifier, false otherwise.
*
*
* @return true if class the static modifier, otherwise false
*/
boolean isStatic();
/**
* (API description of {@link java.lang.reflect.Modifier#isAbstract(int)})
*
* Return true if the class includes the abstract modifier, false otherwise.
*
* @return true if class has the abstract modifier, otherwise false
*/
boolean isAbstract();
/**
* Equivalent of {@link java.lang.Class#isPrimitive()}
*
* @return true if this class represents a primitive, otherwise false
*/
boolean isPrimitive();
/**
* (API description of {@link java.lang.Class#toString()})
*
* Converts the object to a string.
* The string representation is the string "class" or "interface", followed by a space, and then by the fully qualified name of the class in the format returned by getName.
* If this Class object represents a primitive type, this method returns the name of the primitive type.
* If this Class object represents void this method returns "void".
*
* @return a string representation of this class object.
*/
@Override
String toString();
}