Package org.loxlylabs.nestedtext

Record Class TypeMappingRules

java.lang.Object

java.lang.Record

org.loxlylabs.nestedtext.TypeMappingRules

Record Components:

renameFromJava - the Java field we're renaming from

renameTo - the field we're renaming to in the NestedText output

fieldsToIgnore - fields to ignore when serializing

fieldsToIgnoreWhenNull - fields to ignore when serializing if the value is null

public record TypeMappingRules(Map<String,String> renameFromJava, Map<String,String> renameTo, Set<String> fieldsToIgnore, Set<String> fieldsToIgnoreWhenNull)
extends Record

Contains the type level rules for serialization / deserialization.

Constructor Summary

Constructors

Constructor	Description
TypeMappingRules()	Creates a new TypeMappingRules object initializing all fields with empty collections.
TypeMappingRules(Map<String,String> renameFromJava, Map<String,String> renameTo, Set<String> fieldsToIgnore, Set<String> fieldsToIgnoreWhenNull)	Creates a new TypeMappingRules ensuring all arguments are non-null.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Set<String>	fieldsToIgnore()	Returns the value of the fieldsToIgnore record component.
Set<String>	fieldsToIgnoreWhenNull()	Returns the value of the fieldsToIgnoreWhenNull record component.
final int	hashCode()	Returns a hash code value for this object.
Map<String,String>	renameFromJava()	Returns the value of the renameFromJava record component.
Map<String,String>	renameTo()	Returns the value of the renameTo 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

TypeMappingRules

public TypeMappingRules(Map<String,String> renameFromJava,
 Map<String,String> renameTo,
 Set<String> fieldsToIgnore,
 Set<String> fieldsToIgnoreWhenNull)

Creates a new TypeMappingRules ensuring all arguments are non-null.

Parameters:

renameFromJava - the Java field we're renaming from

renameTo - the field we're renaming to in the NestedText output

fieldsToIgnore - fields to ignore when serializing

fieldsToIgnoreWhenNull - fields to ignore when serializing if the value is null

TypeMappingRules

public TypeMappingRules()

Creates a new TypeMappingRules object initializing all fields with empty collections.

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.

renameFromJava

public Map<String,String> renameFromJava()

Returns the value of the renameFromJava record component.

Returns:

the value of the renameFromJava record component

renameTo

public Map<String,String> renameTo()

Returns the value of the renameTo record component.

Returns:

the value of the renameTo record component

fieldsToIgnore

public Set<String> fieldsToIgnore()

Returns the value of the fieldsToIgnore record component.

Returns:

the value of the fieldsToIgnore record component

fieldsToIgnoreWhenNull

public Set<String> fieldsToIgnoreWhenNull()

Returns the value of the fieldsToIgnoreWhenNull record component.

Returns:

the value of the fieldsToIgnoreWhenNull record component