Package mekhq.campaign.mission.newContract.contractGeneration

Enum Class ContractSearchType

java.lang.Object

java.lang.Enum<ContractSearchType>

mekhq.campaign.mission.newContract.contractGeneration.ContractSearchType

All Implemented Interfaces:

Serializable, Comparable<ContractSearchType>, Constable

public enum ContractSearchType
extends Enum<ContractSearchType>

The kind of campaign a contract is being generated for, which drives how employers, objectives, negotiators, and pay are determined. Every campaign faction resolves to exactly one of these categories.

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
GOVERNMENT	A government faction (any campaign faction that is neither mercenary nor pirate).
MERCENARY	A mercenary command, which receives a semi-random employer drawn from the contract search radius.
PIRATE	A pirate band, which selects a victim faction rather than a conventional employer.

Method Summary

Modifier and Type	Method	Description
static ContractSearchType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ContractSearchType[]	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

MERCENARY

public static final ContractSearchType MERCENARY

A mercenary command, which receives a semi-random employer drawn from the contract search radius.

PIRATE

public static final ContractSearchType PIRATE

A pirate band, which selects a victim faction rather than a conventional employer.

GOVERNMENT

public static final ContractSearchType GOVERNMENT

A government faction (any campaign faction that is neither mercenary nor pirate).

Method Details

values

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