Record Class ParameterDescription

java.lang.Object

java.lang.Record

io.github.kaktushose.jdac.definitions.description.ParameterDescription

Record Components:

type - the Class representing the declaredType of this parameter

typeArguments - the generic type arguments of the type (ParameterizedType.getActualTypeArguments()). They only represent the first layer and are all raw types represented as Class instances or null if wildcard/no class.

name - the name of the parameter

annotations - a Collection of all AnnotationDescriptions this parameter is annotated with

All Implemented Interfaces:

Description

public record ParameterDescription(Class<?> type, @Nullable Class<?>[] typeArguments, String name, Collection<AnnotationDescription<?>> annotations)
extends Record
implements Description

A Description that describes a parameter.

Constructor Summary

Constructors

Constructor	Description
ParameterDescription(Class<?> type, @Nullable Class<?>[] typeArguments, String name, Collection<AnnotationDescription<?>> annotations)	Creates an instance of a ParameterDescription record class.

Method Summary

Modifier and Type	Method	Description
Collection<AnnotationDescription<?>>	annotations()	Returns the value of the annotations record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	name()	Returns the value of the name record component.
String	toString()	Returns a string representation of this record class.
Class<?>	type()	Returns the value of the type record component.
@Nullable Class<?>[]	typeArguments()	Returns the value of the typeArguments record component.

Methods inherited from class Object

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

Methods inherited from interface Description

annotation

Constructor Details

ParameterDescription

public ParameterDescription(Class<?> type,
 @Nullable Class<?>[] typeArguments,
 String name,
 Collection<AnnotationDescription<?>> annotations)

Creates an instance of a ParameterDescription record class.

Parameters:

type - the value for the type record component

typeArguments - the value for the typeArguments record component

name - the value for the name record component

annotations - the value for the annotations record component

Method Details

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.

type

public Class<?> type()

Returns the value of the type record component.

Returns:

the value of the type record component

typeArguments

public @Nullable Class<?>[] typeArguments()

Returns the value of the typeArguments record component.

Returns:

the value of the typeArguments record component

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name 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