Package com.planet_ink.coffee_mud.Common

Class DefaultFaction.DefaultFactionRange

java.lang.Object

com.planet_ink.coffee_mud.Common.DefaultFaction.DefaultFactionRange

All Implemented Interfaces:

Faction.FRange, java.lang.Comparable<Faction.FRange>

Enclosing class:

DefaultFaction

public class DefaultFaction.DefaultFactionRange
extends java.lang.Object
implements Faction.FRange, java.lang.Comparable<Faction.FRange>

Field Summary

Fields

Modifier and Type	Field	Description
Faction.Align	alignEquiv
java.lang.String	codeName
Faction	faction
int	high
int	low
java.lang.String	name

Constructor Summary

Constructors

Constructor	Description
DefaultFactionRange(Faction F, java.lang.String key)

Method Summary

Modifier and Type	Method	Description
Faction.Align	alignEquiv()	Returns a constant reflecting whether this range of faction value is equivalent to one of the legacy alignment constant values.
java.lang.String	codeName()	Returns the unique code name that describes this range of faction values
int	compareTo(Faction.FRange o)
Faction	getFaction()	Returns the faction of which this is a range
int	high()	Returns the numerically high value of this faction range
int	low()	Returns the numerically low value of this faction range
int	med()	Returns the numerically median value of this faction range
java.lang.String	name()	Returns the nice friendly displayable name of this faction range, which need not be unique.
int	random()	Returns a random numeric value within this faction range
void	setAlignEquiv(Faction.Align newVal)	Sets a constant reflecting whether this range of faction value is equivalent to one of the legacy alignment constant values.
void	setHigh(int newVal)	Sets the numerically high value of this faction range
void	setLow(int newVal)	Sets the numerically low value of this faction range
void	setName(java.lang.String newVal)	Sets the nice friendly displayable name of this faction range, which need not be unique.
java.lang.String	toString()	Returns a semicolon-delimited representation of this faction range, which can be used to create a new one later.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

low

public int low

high

public int high

name

public java.lang.String name

codeName

public java.lang.String codeName

alignEquiv

public Faction.Align alignEquiv

faction

public Faction faction

Constructor Detail

DefaultFactionRange

public DefaultFactionRange(Faction F,
                           java.lang.String key)

Method Detail

low

public int low()

Description copied from interface: Faction.FRange

Returns the numerically low value of this faction range

Specified by:

low in interface Faction.FRange

Returns:

the numerically low value of this faction range

See Also:

Faction.FRange.setLow(int)

high

public int high()

Description copied from interface: Faction.FRange

Returns the numerically high value of this faction range

Specified by:

high in interface Faction.FRange

Returns:

the numerically high value of this faction range

See Also:

Faction.FRange.setHigh(int)

name

public java.lang.String name()

Description copied from interface: Faction.FRange

Returns the nice friendly displayable name of this faction range, which need not be unique.

Specified by:

name in interface Faction.FRange

Returns:

the name of this range of values

See Also:

Faction.FRange.setName(String)

codeName

public java.lang.String codeName()

Description copied from interface: Faction.FRange

Returns the unique code name that describes this range of faction values

Specified by:

codeName in interface Faction.FRange

Returns:

the unique code name that describes this range of faction values

alignEquiv

public Faction.Align alignEquiv()

Description copied from interface: Faction.FRange

Returns a constant reflecting whether this range of faction value is equivalent to one of the legacy alignment constant values.

Specified by:

alignEquiv in interface Faction.FRange

Returns:

an alignment constant

See Also:

Faction.Align

getFaction

public Faction getFaction()

Description copied from interface: Faction.FRange

Returns the faction of which this is a range

Specified by:

getFaction in interface Faction.FRange

Returns:

the faction of which this is a range

See Also:

Faction.addRange(String)

setLow

public void setLow(int newVal)

Description copied from interface: Faction.FRange

Sets the numerically low value of this faction range

Specified by:

setLow in interface Faction.FRange

Parameters:

newVal - the numerically low value of this faction range

See Also:

Faction.FRange.low()

setHigh

public void setHigh(int newVal)

Description copied from interface: Faction.FRange

Sets the numerically high value of this faction range

Specified by:

setHigh in interface Faction.FRange

Parameters:

newVal - the numerically high value of this faction range

See Also:

Faction.FRange.high()

setName

public void setName(java.lang.String newVal)

Description copied from interface: Faction.FRange

Sets the nice friendly displayable name of this faction range, which need not be unique.

Specified by:

setName in interface Faction.FRange

Parameters:

newVal - the name of this range of values

See Also:

Faction.FRange.name()

setAlignEquiv

public void setAlignEquiv(Faction.Align newVal)

Description copied from interface: Faction.FRange

Sets a constant reflecting whether this range of faction value is equivalent to one of the legacy alignment constant values.

Specified by:

setAlignEquiv in interface Faction.FRange

Parameters:

newVal - a new alignment constant

See Also:

Faction.Align

toString

public java.lang.String toString()

Description copied from interface: Faction.FRange

Returns a semicolon-delimited representation of this faction range, which can be used to create a new one later.

Specified by:

toString in interface Faction.FRange

Overrides:

toString in class java.lang.Object

Returns:

a semicolon-delimited range

See Also:

Faction.addRange(String)

random

public int random()

Description copied from interface: Faction.FRange

Returns a random numeric value within this faction range

Specified by:

random in interface Faction.FRange

Returns:

a random numeric value within this faction range

med

public int med()

Description copied from interface: Faction.FRange

Returns the numerically median value of this faction range

Specified by:

med in interface Faction.FRange

Returns:

the numerically median value of this faction range

compareTo

public int compareTo(Faction.FRange o)

Specified by:

compareTo in interface java.lang.Comparable<Faction.FRange>