DefaultClanPosition

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.planet_ink.coffee_mud.Common
Class DefaultClanPosition

java.lang.Object
  com.planet_ink.coffee_mud.Common.DefaultClanPosition

All Implemented Interfaces:: ClanPosition, CMCommon, CMObject, Modifiable, java.lang.Cloneable, java.lang.Comparable<CMObject>

public class DefaultClanPosition
extends java.lang.Object
implements ClanPosition
extends java.lang.Object
implements ClanPosition

Field Summary
`protected Clan.Authority[]`	`functionChart` a chart of whether this position can perform the indexed function in this government
`protected java.lang.String`	`ID` the named ID of the position
`protected java.lang.String`	`innerMaskStr` the internal zapper mask for internal requirements to this position
`protected boolean`	`isPublic` the internal zapper mask for internal requirements to this position
`protected int`	`max` the maximum number of members that can hold this position
`protected java.lang.String`	`name` the name of the position within this government
`protected java.lang.String`	`pluralName` the plural name of the position within this government
`protected int`	`rank` the ordered rank of the position
`protected int`	`roleID` the named ID of the position

Constructor Summary
`DefaultClanPosition()`

Method Summary
`int`	`compareTo(CMObject o)`
`CMObject`	`copyOf()` Similar to Cloneable.clone(), but does its best to make sure that any internal objects to this class are also copyOfed.
`Clan.Authority[]`	`getFunctionChart()` Gets the function chart.
`java.lang.String`	`getID()` Gets the iD.
`java.lang.String`	`getInnerMaskStr()` Gets the inner mask str.
`int`	`getMax()` Gets the max.
`java.lang.String`	`getName()` Gets the name.
`java.lang.String`	`getPluralName()` Gets the plural name.
`int`	`getRank()` Gets the rank.
`int`	`getRoleID()` Gets the role id.
`int`	`getSaveStatIndex()` Returns the index into the stat codes array where extra savable fields begins.
`java.lang.String`	`getStat(java.lang.String code)` An alternative means of retreiving the values of those fields on this object which are modifiable at run-time by builders.
`java.lang.String[]`	`getStatCodes()` Returns an array of the string names of those fields which are modifiable on this object at run-time by builders.
`java.lang.String`	`ID()` The CoffeeMud Java Class ID shared by all instances of this object.
`void`	`initializeClass()` Called ONCE after all objects are loaded, but before the map is read in during initialization.
`boolean`	`isPublic()` Checks if is public.
`boolean`	`isStat(java.lang.String code)` An alternative means of retreiving the values of those fields on this object which are modifiable at run-time by builders.
`java.lang.String`	`name()` The displayable name of this object.
`CMObject`	`newInstance()` return a new instance of the object
`void`	`setFunctionChart(Clan.Authority[] functionChart)` Sets the function chart.
`void`	`setID(java.lang.String iD)` Sets the iD.
`void`	`setInnerMaskStr(java.lang.String innerMaskStr)` Sets the inner mask str.
`void`	`setMax(int max)` Sets the max.
`void`	`setName(java.lang.String name)` Sets the name.
`void`	`setPluralName(java.lang.String pluralName)` Sets the plural name.
`void`	`setPublic(boolean isPublic)` Sets the public.
`void`	`setRank(int rank)` Sets the rank.
`void`	`setRoleID(int roleID)` Sets the role id.
`void`	`setStat(java.lang.String code, java.lang.String val)` An alternative means of setting the values of those fields on this object which are modifiable at run-time by builders.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

ID

protected java.lang.String ID

the named ID of the position

roleID

protected int roleID

the named ID of the position

rank

protected int rank

the ordered rank of the position

name

protected java.lang.String name

the name of the position within this government

pluralName

protected java.lang.String pluralName

the plural name of the position within this government

max

protected int max

the maximum number of members that can hold this position

innerMaskStr

protected java.lang.String innerMaskStr

the internal zapper mask for internal requirements to this position

isPublic

protected boolean isPublic

the internal zapper mask for internal requirements to this position

functionChart

protected Clan.Authority[] functionChart

a chart of whether this position can perform the indexed function in this government

Constructor Detail

DefaultClanPosition

public DefaultClanPosition()

Method Detail

ID

public java.lang.String ID()

Description copied from interface: CMObject

The CoffeeMud Java Class ID shared by all instances of this object. Unlike the Java Class name, this method does not include package information. However, it must return a String value unique to its class category in the ClassLoader. Class categories include Libraries, Common, Areas, Abilities, Behaviors, CharClasses, Commands, Exits Locales, MOBS, Races, WebMacros, Basic Items, Armor, Weapons, ClanItems, Tech. The name is typically identical to the class name.

Specified by:: ID in interface CMObject

Returns:: the name of this class

name

public java.lang.String name()

Description copied from interface: CMObject

The displayable name of this object. May be modified by phyStats() object. Is derived from the Name().

Specified by:: name in interface CMObject

Returns:: the modified final name of this object on the map.
See Also:: Environmental.Name()

newInstance

public CMObject newInstance()

return a new instance of the object

Specified by:: newInstance in interface CMObject

Returns:: a new instance of this class

initializeClass

public void initializeClass()

Description copied from interface: CMObject

Called ONCE after all objects are loaded, but before the map is read in during initialization.

Specified by:: initializeClass in interface CMObject

compareTo

public int compareTo(CMObject o)

Specified by:: compareTo in interface java.lang.Comparable<CMObject>

copyOf

public CMObject copyOf()

Description copied from interface: CMObject

Similar to Cloneable.clone(), but does its best to make sure that any internal objects to this class are also copyOfed.

Specified by:: copyOf in interface CMObject

Returns:: a clone of this object