Package mekhq.campaign.universe.enums

Enum Class BattleMekFactionGenerationMethod

java.lang.Object

java.lang.Enum<BattleMekFactionGenerationMethod>

mekhq.campaign.universe.enums.BattleMekFactionGenerationMethod

All Implemented Interfaces:

Serializable, Comparable<BattleMekFactionGenerationMethod>, Constable

public enum BattleMekFactionGenerationMethod
extends Enum<BattleMekFactionGenerationMethod>

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
CAMPAIGN_FACTION
ORIGIN_FACTION
SPECIFIED_FACTION

Method Summary

Modifier and Type	Method	Description
Faction	generateFaction(Person person, Campaign campaign, Faction specifiedFaction)
String	getToolTipText()
boolean	isCampaignFaction()
boolean	isOriginFaction()
boolean	isSpecifiedFaction()
String	toString()
static BattleMekFactionGenerationMethod	valueOf(String name)	Returns the enum constant of this class with the specified name.
static BattleMekFactionGenerationMethod[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ORIGIN_FACTION

public static final BattleMekFactionGenerationMethod ORIGIN_FACTION

CAMPAIGN_FACTION

public static final BattleMekFactionGenerationMethod CAMPAIGN_FACTION

SPECIFIED_FACTION

public static final BattleMekFactionGenerationMethod SPECIFIED_FACTION

Method Details

values

public static BattleMekFactionGenerationMethod[] 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 BattleMekFactionGenerationMethod 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

getToolTipText

public String getToolTipText()

isOriginFaction

public boolean isOriginFaction()

isCampaignFaction

public boolean isCampaignFaction()

isSpecifiedFaction

public boolean isSpecifiedFaction()

generateFaction

public Faction generateFaction(Person person,
 Campaign campaign,
 Faction specifiedFaction)

toString

public String toString()

Overrides:

toString in class Enum<BattleMekFactionGenerationMethod>