Record Class CsvNames

java.lang.Object

java.lang.Record

com.cleanroommc.gradle.api.names.CsvNames

public record CsvNames(Map<String,String> fields, Map<String,String> methods, Map<String,String> params, Map<String,String> docs)
extends Record

The SRG -> name lookups from a legacy MCP names zip (fields.csv, methods.csv, params.csv). Columns are searge, name, side, desc. The desc of methods/fields becomes the member's javadoc.

Constructor Summary

Constructors

Constructor	Description
CsvNames(Map<String,String> fields, Map<String,String> methods, Map<String,String> params, Map<String,String> docs)	Creates an instance of a CsvNames record class.

Method Summary

Modifier and Type	Method	Description
Map<String,String>	docs()	Returns the value of the docs record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Map<String,String>	fields()	Returns the value of the fields record component.
static CsvNames	fromZip(File zipFile)	Reads the three CSVs out of an MCP names zip.
final int	hashCode()	Returns a hash code value for this object.
Map<String,String>	methods()	Returns the value of the methods record component.
Map<String,String>	params()	Returns the value of the params record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

CsvNames

public CsvNames(Map<String,String> fields,
 Map<String,String> methods,
 Map<String,String> params,
 Map<String,String> docs)

Creates an instance of a CsvNames record class.

Parameters:

fields - the value for the fields record component

methods - the value for the methods record component

params - the value for the params record component

docs - the value for the docs record component

Method Details

fromZip

public static CsvNames fromZip(File zipFile)

Reads the three CSVs out of an MCP names zip.

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.

fields

public Map<String,String> fields()

Returns the value of the fields record component.

Returns:

the value of the fields record component

methods

public Map<String,String> methods()

Returns the value of the methods record component.

Returns:

the value of the methods record component

params

public Map<String,String> params()

Returns the value of the params record component.

Returns:

the value of the params record component

docs

public Map<String,String> docs()

Returns the value of the docs record component.

Returns:

the value of the docs record component