net.lenni0451.optconfig.access.types

Interface ClassAccess

All Known Implementing Classes:

MethodHandleClassAccess, ReflectionClassAccess

public interface ClassAccess

A class which can be accessed by optconfig (e.g. using reflection).

Method Summary

Modifier and Type	Method and Description
<T extends java.lang.annotation.Annotation> T	getAnnotation(java.lang.Class<T> annotationClass) Get an annotation of the class.
java.lang.Class<?>	getClazz()
default ConstructorAccess	getConstructor(java.lang.Class<?>... parameterTypes) Get a constructor with the given parameter types.
ConstructorAccess[]	getConstructors()
FieldAccess[]	getFields()
ClassAccess[]	getInnerClasses()
default MethodAccess	getMethod(java.lang.String name, java.lang.Class<?> returnType, java.lang.Class<?>... parameterTypes) Get a method with the given name and parameter types.
MethodAccess[]	getMethods()
default ConstructorAccess	tryGetConstructor(java.lang.Class<?>... parameterTypes) Try to get a constructor with the given parameter types.
default MethodAccess	tryGetMethod(java.lang.String name, java.lang.Class<?> returnType, java.lang.Class<?>... parameterTypes) Try to get a method with the given name and parameter types.

Method Detail

getClazz

java.lang.Class<?> getClazz()

Returns:

The class

getConstructors

ConstructorAccess[] getConstructors()

Returns:

All constructors of the class

See Also:

Class.getDeclaredConstructors()

getConstructor

default ConstructorAccess getConstructor(java.lang.Class<?>... parameterTypes)

Get a constructor with the given parameter types.

Parameters:

parameterTypes - The parameter types of the constructor

Returns:

The constructor

Throws:

java.lang.IllegalArgumentException - If no constructor with the given parameter types was found

tryGetConstructor

@Nullable
default ConstructorAccess tryGetConstructor(java.lang.Class<?>... parameterTypes)

Try to get a constructor with the given parameter types.

Parameters:

parameterTypes - The parameter types of the constructor

Returns:

The constructor or null if no constructor with the given parameter types was found

getFields

FieldAccess[] getFields()

Returns:

All fields of the class

See Also:

Class.getDeclaredFields()

getMethods

MethodAccess[] getMethods()

Returns:

All methods of the class

See Also:

Class.getDeclaredMethods()

getMethod

default MethodAccess getMethod(java.lang.String name,
                               java.lang.Class<?> returnType,
                               java.lang.Class<?>... parameterTypes)

Get a method with the given name and parameter types.

Parameters:

name - The name of the method

returnType - The return type of the method

parameterTypes - The parameter types of the method

Returns:

The method

tryGetMethod

@Nullable
default MethodAccess tryGetMethod(java.lang.String name,
                                             java.lang.Class<?> returnType,
                                             java.lang.Class<?>... parameterTypes)

Try to get a method with the given name and parameter types.

Parameters:

name - The name of the method

returnType - The return type of the method

parameterTypes - The parameter types of the method

Returns:

The method or null if no method with the given name and parameter types was found

getInnerClasses

ClassAccess[] getInnerClasses()

Returns:

All inner classes of the class

See Also:

Class.getDeclaredClasses()

getAnnotation

<T extends java.lang.annotation.Annotation> T getAnnotation(java.lang.Class<T> annotationClass)

Get an annotation of the class.

Type Parameters:

T - The type of the annotation

Parameters:

annotationClass - The class of the annotation

Returns:

The annotation or null if the class does not have this annotation

See Also:

Class.getDeclaredAnnotation(Class)