Package tools.refinery.language.documentation

Record Class ParsedDocumentation

java.lang.Object

java.lang.Record

tools.refinery.language.documentation.ParsedDocumentation

public record ParsedDocumentation(Map<String,String> userData, Map<String,String> parameterDocumentation)
extends Record

Field Summary

Fields

Modifier and Type	Field	Description
static final ParsedDocumentation	EMPTY

Constructor Summary

Constructors

Constructor	Description
ParsedDocumentation(Map<String,String> userData, Map<String,String> parameterDocumentation)	Creates an instance of a ParsedDocumentation record class.

Method Summary

Modifier and Type	Method	Description
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.
Map<String,String>	parameterDocumentation()	Returns the value of the parameterDocumentation record component.
final String	toString()	Returns a string representation of this record class.
Map<String,String>	userData()	Returns the value of the userData record component.

Methods inherited from class java.lang.Object

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

Field Details

EMPTY

public static final ParsedDocumentation EMPTY

Constructor Details

ParsedDocumentation

public ParsedDocumentation(Map<String,String> userData,
 Map<String,String> parameterDocumentation)

Creates an instance of a ParsedDocumentation record class.

Parameters:

userData - the value for the userData record component

parameterDocumentation - the value for the parameterDocumentation 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.

userData

public Map<String,String> userData()

Returns the value of the userData record component.

Returns:

the value of the userData record component

parameterDocumentation

public Map<String,String> parameterDocumentation()

Returns the value of the parameterDocumentation record component.

Returns:

the value of the parameterDocumentation record component