Package megamek.client.ratgenerator

Record Class FormationNamingConvention.Tier

java.lang.Object

java.lang.Record

megamek.client.ratgenerator.FormationNamingConvention.Tier

Record Components:

echelon - the echelon this rule applies to, after constant substitution

designatorStyle - how formations at this echelon are designated among their siblings

qualifiedByParent - whether the parent formation's designator is prepended, which is what keeps names unique once a designator sequence restarts under each parent (1/Alpha Company rather than a bare Alpha Company repeated in every battalion)

Enclosing class:

FormationNamingConvention

public static record FormationNamingConvention.Tier(int echelon, FormationNamingConvention.DesignatorStyle designatorStyle, boolean qualifiedByParent)
extends Record

The naming rule for one echelon.

Constructor Summary

Constructors

Constructor	Description
Tier(int echelon, FormationNamingConvention.DesignatorStyle designatorStyle, boolean qualifiedByParent)	Creates an instance of a Tier record class.

Method Summary

Modifier and Type	Method	Description
FormationNamingConvention.DesignatorStyle	designatorStyle()	Returns the value of the designatorStyle record component.
int	echelon()	Returns the value of the echelon 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.
boolean	qualifiedByParent()	Returns the value of the qualifiedByParent 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

Tier

public Tier(int echelon,
 FormationNamingConvention.DesignatorStyle designatorStyle,
 boolean qualifiedByParent)

Creates an instance of a Tier record class.

Parameters:

echelon - the value for the echelon record component

designatorStyle - the value for the designatorStyle record component

qualifiedByParent - the value for the qualifiedByParent 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

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.

echelon

public int echelon()

Returns the value of the echelon record component.

Returns:

the value of the echelon record component

designatorStyle

public FormationNamingConvention.DesignatorStyle designatorStyle()

Returns the value of the designatorStyle record component.

Returns:

the value of the designatorStyle record component

qualifiedByParent

public boolean qualifiedByParent()

Returns the value of the qualifiedByParent record component.

Returns:

the value of the qualifiedByParent record component