Package megameklab.printing

Enum Class MekChassisArrangement

java.lang.Object

java.lang.Enum<MekChassisArrangement>

megameklab.printing.MekChassisArrangement

All Implemented Interfaces:

Serializable, Comparable<MekChassisArrangement>, Constable

public enum MekChassisArrangement
extends Enum<MekChassisArrangement>

This class represents the different types of arrangement of the chassis names of those Meks that have a Clan and an IS name such as the Mad Cat a.k.a. Timber Wolf. This is used to determine how to print those names on record sheets (but not elsewhere as we might not want this to be dependent on how the record sheets might be at any moment).

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLAN_IS
CLAN_ONLY
IS_CLAN
IS_ONLY

Method Summary

Modifier and Type	Method	Description
String	getDisplayName()
static MekChassisArrangement	parse(String arrangementName)	Parses the given String, returning the ClanIsMekNameArrangement fitting the String like the valueOf() method does, but returns CLAN_IS when it can't be parsed (instead of null).
String	printChassis(megamek.common.units.Entity entity)
static MekChassisArrangement	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MekChassisArrangement[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CLAN_IS

public static final MekChassisArrangement CLAN_IS

IS_CLAN

public static final MekChassisArrangement IS_CLAN

CLAN_ONLY

public static final MekChassisArrangement CLAN_ONLY

IS_ONLY

public static final MekChassisArrangement IS_ONLY

Method Details

values

public static MekChassisArrangement[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static MekChassisArrangement valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getDisplayName

public String getDisplayName()

Returns:

A display name for this ClanIsMekNameArrangement taken from the resources (possibly localised).

parse

public static MekChassisArrangement parse(String arrangementName)

Parses the given String, returning the ClanIsMekNameArrangement fitting the String like the valueOf() method does, but returns CLAN_IS when it can't be parsed (instead of null).

Parameters:

arrangementName - A string giving one of the ClanIsMekNameArrangement values

Returns:

the MekChassisArrangement parsed from the string or CLAN_IS. Never returns null.

printChassis

public String printChassis(megamek.common.units.Entity entity)