Record Class ClassDescription

java.lang.Object

java.lang.Record

io.github.kaktushose.jdac.definitions.description.ClassDescription

Record Components:

clazz - the Class this Description describes.

name - the full name including packages of the class

packageDescription - the PackageDescription representing the package returned by Class.getPackage()

annotations - a Collection of all Annotations this class is annotated with

methods - a Collection of all the public methods of this class

All Implemented Interfaces:

Description

public record ClassDescription(Class<?> clazz, String name, PackageDescription packageDescription, Collection<AnnotationDescription<?>> annotations, Collection<MethodDescription> methods)
extends Record
implements Description

A Description that describes a class.

Constructor Summary

Constructors

Constructor	Description
ClassDescription(Class<?> clazz, String name, PackageDescription packageDescription, Collection<AnnotationDescription<?>> annotations, Collection<MethodDescription> methods)	Creates an instance of a ClassDescription record class.

Method Summary

Modifier and Type	Method	Description
Collection<AnnotationDescription<?>>	annotations()	Returns the value of the annotations record component.
Class<?>	clazz()	Returns the value of the clazz record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Optional<MethodDescription>	findMethod(String name, Class<?>... parameters)	Gets a method that matches the given name and parameter types if found.
Optional<MethodDescription>	findMethod(String name, List<Class<?>> parameters)	Gets a method that matches the given name and parameter types if found.
Collection<MethodDescription>	findMethods(String name)	Gets methods that matches the given name.
final int	hashCode()	Returns a hash code value for this object.
MethodDescription	method(String name, Class<?>... parameters)	Gets a method that matches the given name and parameter types.
MethodDescription	method(String name, List<Class<?>> parameters)	Gets a method that matches the given name and parameter types.
Collection<MethodDescription>	methods()	Returns the value of the methods record component.
String	name()	Returns the value of the name record component.
PackageDescription	packageDescription()	Returns the value of the packageDescription record component.
String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Description

annotation, findAnnotation, hasAnnotation

Constructor Details

ClassDescription

public ClassDescription(Class<?> clazz,
 String name,
 PackageDescription packageDescription,
 Collection<AnnotationDescription<?>> annotations,
 Collection<MethodDescription> methods)

Creates an instance of a ClassDescription record class.

Parameters:

clazz - the value for the clazz record component

name - the value for the name record component

packageDescription - the value for the packageDescription record component

annotations - the value for the annotations record component

methods - the value for the methods record component

Method Details

findMethods

public Collection<MethodDescription> findMethods(String name)

Gets methods that matches the given name.

Parameters:

name - the method name

Returns:

a Collection of the found MethodDescriptions or an empty Collection if no methods were found

findMethod

public Optional<MethodDescription> findMethod(String name,
 List<Class<?>> parameters)

Gets a method that matches the given name and parameter types if found.

Parameters:

name - the method name

parameters - the method parameters, as stored by ParameterDescription.type()

Returns:

the found MethodDescription or Optional.empty()

findMethod

public Optional<MethodDescription> findMethod(String name,
 Class<?>... parameters)

Gets a method that matches the given name and parameter types if found.

Parameters:

name - the method name

parameters - the method parameters, as stored by ParameterDescription.type()

Returns:

the found MethodDescription or Optional.empty()

method

public MethodDescription method(String name,
 List<Class<?>> parameters)

Gets a method that matches the given name and parameter types. Throws if no matching method was found.

Parameters:

name - the method name

parameters - the method parameters, as stored by ParameterDescription.type()

Returns:

the found MethodDescription

Throws:

NoSuchElementException - if no element was found

See Also:

• Optional.orElseThrow()

method

public MethodDescription method(String name,
 Class<?>... parameters)

Gets a method that matches the given name and parameter types. Throws if no matching method was found.

Parameters:

name - the method name

parameters - the method parameters, as stored by ParameterDescription.type()

Returns:

the found MethodDescription

Throws:

NoSuchElementException - if no element was found

See Also:

• Optional.orElseThrow()

toString

public String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

clazz

public Class<?> clazz()

Returns the value of the clazz record component.

Returns:

the value of the clazz record component

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

packageDescription

public PackageDescription packageDescription()

Returns the value of the packageDescription record component.

Returns:

the value of the packageDescription record component

annotations

public Collection<AnnotationDescription<?>> annotations()

Returns the value of the annotations record component.

Specified by:

annotations in interface Description

Returns:

the value of the annotations record component

methods

public Collection<MethodDescription> methods()

Returns the value of the methods record component.

Returns:

the value of the methods record component