Package run.halo.gradle.openapi

Record Class AbstractOpenApiDocsTask.SpringDocGroupConfig

java.lang.Object

java.lang.Record

run.halo.gradle.openapi.AbstractOpenApiDocsTask.SpringDocGroupConfig

Enclosing class:

AbstractOpenApiDocsTask

protected static record AbstractOpenApiDocsTask.SpringDocGroupConfig(String group, String displayName, List<String> pathsToMatch, List<String> pathsToExclude)
extends Record

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractOpenApiDocsTask.SpringDocGroupConfig.SpringDocGroupConfigBuilder

Constructor Summary

Constructors

Constructor	Description
SpringDocGroupConfig(String group, String displayName, List<String> pathsToMatch, List<String> pathsToExclude)	Creates an instance of a SpringDocGroupConfig record class.

Method Summary

Modifier and Type	Method	Description
static AbstractOpenApiDocsTask.SpringDocGroupConfig.SpringDocGroupConfigBuilder	builder()
String	displayName()	Returns the value of the displayName record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	group()	Returns the value of the group record component.
final int	hashCode()	Returns a hash code value for this object.
List<String>	pathsToExclude()	Returns the value of the pathsToExclude record component.
List<String>	pathsToMatch()	Returns the value of the pathsToMatch 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

SpringDocGroupConfig

public SpringDocGroupConfig(String group,
 String displayName,
 List<String> pathsToMatch,
 List<String> pathsToExclude)

Creates an instance of a SpringDocGroupConfig record class.

Parameters:

group - the value for the group record component

displayName - the value for the displayName record component

pathsToMatch - the value for the pathsToMatch record component

pathsToExclude - the value for the pathsToExclude record component

Method Details

builder

public static AbstractOpenApiDocsTask.SpringDocGroupConfig.SpringDocGroupConfigBuilder builder()

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.

group

public String group()

Returns the value of the group record component.

Returns:

the value of the group record component

displayName

public String displayName()

Returns the value of the displayName record component.

Returns:

the value of the displayName record component

pathsToMatch

public List<String> pathsToMatch()

Returns the value of the pathsToMatch record component.

Returns:

the value of the pathsToMatch record component

pathsToExclude

public List<String> pathsToExclude()

Returns the value of the pathsToExclude record component.

Returns:

the value of the pathsToExclude record component