Module spring.modulith.docs

Package org.springframework.modulith.docs.metadata

Record Class TypeMetadata

java.lang.Object

java.lang.Record

org.springframework.modulith.docs.metadata.TypeMetadata

public record TypeMetadata(String name, String comment, List<MethodMetadata> methods)
extends Record

Metadata about a Java type.

Since:

1.3

Author:

Oliver Drotbohm

Constructor Summary

Constructors

Constructor	Description
TypeMetadata(String name, String comment, List<MethodMetadata> methods)	Creates an instance of a TypeMetadata record class.

Method Summary

Modifier and Type	Method	Description
String	comment()	Returns the value of the comment 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.
List<MethodMetadata>	methods()	Returns the value of the methods record component.
String	name()	Returns the value of the name record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

TypeMetadata

public TypeMetadata(String name,
 @Nullable
 String comment,
 List<MethodMetadata> methods)

Creates an instance of a TypeMetadata record class.

Parameters:

name - the value for the name record component

comment - the value for the comment record component

methods - the value for the methods record component

Method Details

toString

public final 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.

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

comment

@Nullable
public String comment()

Returns the value of the comment record component.

Returns:

the value of the comment record component

methods

public List<MethodMetadata> methods()

Returns the value of the methods record component.

Returns:

the value of the methods record component