Package com.planet_ink.coffee_mud.Libraries

Class CMAbleParms.AbilityParmEditorImpl

java.lang.Object

com.planet_ink.coffee_mud.Libraries.CMAbleParms.AbilityParmEditorImpl

All Implemented Interfaces:

AbilityParameters.AbilityParmEditor

Enclosing class:

CMAbleParms

protected abstract class CMAbleParms.AbilityParmEditorImpl
extends java.lang.Object
implements AbilityParameters.AbilityParmEditor

Field Summary

Fields

Modifier and Type	Field	Description
protected PairList<java.lang.String,java.lang.String>	choices

Constructor Summary

Constructors

Constructor	Description
AbilityParmEditorImpl(java.lang.String fieldName, java.lang.String shortHeader, AbilityParameters.ParmType type)

Method Summary

Modifier and Type	Method	Description
int	appliesToClass(java.lang.Object o)	Returns how much this editor applies as the appropriate editor to the given object.
PairList<java.lang.String,java.lang.String>	choices()	Creates key/display pairs whose identity depends entirely on this editor.
java.lang.String	colHeader()	The displayable name of this column.
java.lang.String	commandLinePrompt(MOB mob, java.lang.String oldVal, int[] showNumber, int showFlag)	Presents the given mob player the official command line prompt for this editor and lets them enter a value or values before returning the final value as a result.
java.lang.String	commandLineValue(java.lang.String oldVal)	When building a display table for the command line interface, this will return the desired display value for the desired field and old value.
boolean	confirmValue(java.lang.String oldVal)	Returns whether the given value constitutes a valid value for this editor.
PairList<java.lang.String,java.lang.String>	createBinaryChoices(java.lang.String[] S)
abstract void	createChoices()
PairList<java.lang.String,java.lang.String>	createChoices(java.lang.String[] S)	Creates key/display pairs from a list of strings whose identity depends entirely on this editor.
PairList<java.lang.String,java.lang.String>	createChoices(java.util.Enumeration<? extends java.lang.Object> e)	Creates key/display pairs from an enumeration of objects whose identity depends entirely on this editor.
PairList<java.lang.String,java.lang.String>	createChoices(java.util.List<? extends java.lang.Object> V)	Creates key/display pairs from a list of objects whose identity depends entirely on this editor.
PairList<java.lang.String,java.lang.String>	createNumberedChoices(java.lang.String[] S)
java.lang.String[]	fakeUserInput(java.lang.String oldVal)	Presents fake user input for testing.
java.lang.String	ID()	The code-word/identifier for this editor.
int	maxColWidth()	The maximum width to give this column when building a table This is a nominal value, so Integer.MAX_VALUE would be a good default.
int	minColWidth()	The minimum width to give this column when building a table This is a nominal value, so 0 would be a good default.
AbilityParameters.ParmType	parmType()	The general type of data being manipulated by the editor.
java.lang.String	prompt()	The display prompt used for command line editors.
java.lang.String	webField(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq, java.util.Map<java.lang.String,java.lang.String> parms, java.lang.String oldVal, java.lang.String fieldName)	Returns the html tag field, complete with current value, for this editor
java.lang.String	webTableField(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq, java.util.Map<java.lang.String,java.lang.String> parms, java.lang.String oldVal)	The current web value of this field, sufficient to be put into the overview table showing the value of all the fields.
java.lang.String	webValue(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq, java.util.Map<java.lang.String,java.lang.String> parms, java.lang.String oldVal, java.lang.String fieldName)	The current web value of this field, sufficient to be put into the VALUE field of a text or hidden tag.

Methods inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.AbilityParameters.AbilityParmEditor

convertFromItem, defaultValue

Methods inherited from class java.lang.Object

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

Field Detail

choices

protected PairList<java.lang.String,java.lang.String> choices

Constructor Detail

AbilityParmEditorImpl

public AbilityParmEditorImpl(java.lang.String fieldName,
                             java.lang.String shortHeader,
                             AbilityParameters.ParmType type)

Method Detail

ID

public java.lang.String ID()

Description copied from interface: AbilityParameters.AbilityParmEditor

The code-word/identifier for this editor. Corresponds directly to the bits in the coded parameter string.

Specified by:

ID in interface AbilityParameters.AbilityParmEditor

Returns:

code-word/identifier for this editor

parmType

public AbilityParameters.ParmType parmType()

Description copied from interface: AbilityParameters.AbilityParmEditor

The general type of data being manipulated by the editor.

Specified by:

parmType in interface AbilityParameters.AbilityParmEditor

Returns:

general type of data being manipulated by the editor

See Also:

AbilityParameters.ParmType

prompt

public java.lang.String prompt()

Description copied from interface: AbilityParameters.AbilityParmEditor

The display prompt used for command line editors.

Specified by:

prompt in interface AbilityParameters.AbilityParmEditor

Returns:

display prompt used for command line editors.

colHeader

public java.lang.String colHeader()

Description copied from interface: AbilityParameters.AbilityParmEditor

The displayable name of this column.

Specified by:

colHeader in interface AbilityParameters.AbilityParmEditor

Returns:

displayable name of this column.

maxColWidth

public int maxColWidth()

Description copied from interface: AbilityParameters.AbilityParmEditor

The maximum width to give this column when building a table This is a nominal value, so Integer.MAX_VALUE would be a good default.

Specified by:

maxColWidth in interface AbilityParameters.AbilityParmEditor

Returns:

maximum width to give this column when building a table

minColWidth

public int minColWidth()

Description copied from interface: AbilityParameters.AbilityParmEditor

The minimum width to give this column when building a table This is a nominal value, so 0 would be a good default.

Specified by:

minColWidth in interface AbilityParameters.AbilityParmEditor

Returns:

minimum width to give this column when building a table

confirmValue

public boolean confirmValue(java.lang.String oldVal)

Description copied from interface: AbilityParameters.AbilityParmEditor

Returns whether the given value constitutes a valid value for this editor.

Specified by:

confirmValue in interface AbilityParameters.AbilityParmEditor

Parameters:

oldVal - the data to check

Returns:

true if the value is acceptable, false otherwise

fakeUserInput

public java.lang.String[] fakeUserInput(java.lang.String oldVal)

Description copied from interface: AbilityParameters.AbilityParmEditor

Presents fake user input for testing. The String array is the pre-parsed commands that a user would have entered to satisfy the prompt or prompts represented by this editor.

Specified by:

fakeUserInput in interface AbilityParameters.AbilityParmEditor

Parameters:

oldVal - the current value

Returns:

fake user input for testing

commandLinePrompt

public java.lang.String commandLinePrompt(MOB mob,
                                          java.lang.String oldVal,
                                          int[] showNumber,
                                          int showFlag)
                                   throws java.io.IOException

Description copied from interface: AbilityParameters.AbilityParmEditor

Presents the given mob player the official command line prompt for this editor and lets them enter a value or values before returning the final value as a result.

Specified by:

commandLinePrompt in interface AbilityParameters.AbilityParmEditor

Parameters:

mob - the player who is being prompted

oldVal - the old/previous value for this field

showNumber - the arbitrary number of this field 1, 2, 3..

showFlag - same as shownumber to edit, -1 to display, -999 to always edit

Returns:

the value entered by the user

Throws:

java.io.IOException - typically means a dropped carrier

webValue

public java.lang.String webValue(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq,
                                 java.util.Map<java.lang.String,java.lang.String> parms,
                                 java.lang.String oldVal,
                                 java.lang.String fieldName)

Description copied from interface: AbilityParameters.AbilityParmEditor

The current web value of this field, sufficient to be put into the VALUE field of a text or hidden tag.

Specified by:

webValue in interface AbilityParameters.AbilityParmEditor

Parameters:

httpReq - the request objects, containing access to url parameters

parms - the tag url parameters map

oldVal - the original previous value of this field

fieldName - the name of the field

Returns:

current web value of this field

webTableField

public java.lang.String webTableField(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq,
                                      java.util.Map<java.lang.String,java.lang.String> parms,
                                      java.lang.String oldVal)

Description copied from interface: AbilityParameters.AbilityParmEditor

The current web value of this field, sufficient to be put into the overview table showing the value of all the fields.

Specified by:

webTableField in interface AbilityParameters.AbilityParmEditor

Parameters:

httpReq - the request objects, containing access to url parameters

parms - the tag url parameters map

oldVal - the original previous value of this field

Returns:

current web value of this field for an overview table

commandLineValue

public java.lang.String commandLineValue(java.lang.String oldVal)

Description copied from interface: AbilityParameters.AbilityParmEditor

When building a display table for the command line interface, this will return the desired display value for the desired field and old value.

Specified by:

commandLineValue in interface AbilityParameters.AbilityParmEditor

Parameters:

oldVal - the current value

Returns:

the desired value, usually oldVal

webField

public java.lang.String webField(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq,
                                 java.util.Map<java.lang.String,java.lang.String> parms,
                                 java.lang.String oldVal,
                                 java.lang.String fieldName)

Description copied from interface: AbilityParameters.AbilityParmEditor

Returns the html tag field, complete with current value, for this editor

Specified by:

webField in interface AbilityParameters.AbilityParmEditor

Parameters:

httpReq - the request objects, containing access to url parameters

parms - the tag url parameters map

oldVal - the original previous value of this field

fieldName - the name of the field

Returns:

the html tag field, complete with current value, for this editor

createChoices

public abstract void createChoices()

createChoices

public PairList<java.lang.String,java.lang.String> createChoices(java.util.Enumeration<? extends java.lang.Object> e)

Description copied from interface: AbilityParameters.AbilityParmEditor

Creates key/display pairs from an enumeration of objects whose identity depends entirely on this editor. It returns a pair list where the first entry is the actual returnable value, and the second is the user-enterable selectable display key.

Specified by:

createChoices in interface AbilityParameters.AbilityParmEditor

Parameters:

e - the enumeration of objects to create choices from

Returns:

key/display pairs

createChoices

public PairList<java.lang.String,java.lang.String> createChoices(java.util.List<? extends java.lang.Object> V)

Description copied from interface: AbilityParameters.AbilityParmEditor

Creates key/display pairs from a list of objects whose identity depends entirely on this editor. It returns a pair list where the first entry is the actual returnable value, and the second is the user-enterable selectable display key.

Specified by:

createChoices in interface AbilityParameters.AbilityParmEditor

Parameters:

V - the list of objects to create choices from

Returns:

key/display pairs

createChoices

public PairList<java.lang.String,java.lang.String> createChoices(java.lang.String[] S)

Description copied from interface: AbilityParameters.AbilityParmEditor

Creates key/display pairs from a list of strings whose identity depends entirely on this editor. It returns a pair list where the first entry is the actual returnable value, and the second is the user-enterable selectable display key. In this case, they would both be the same.

Specified by:

createChoices in interface AbilityParameters.AbilityParmEditor

Parameters:

S - the array of strings to create choices from

Returns:

key/display pairs

createBinaryChoices

public PairList<java.lang.String,java.lang.String> createBinaryChoices(java.lang.String[] S)

createNumberedChoices

public PairList<java.lang.String,java.lang.String> createNumberedChoices(java.lang.String[] S)

choices

public PairList<java.lang.String,java.lang.String> choices()

Description copied from interface: AbilityParameters.AbilityParmEditor

Creates key/display pairs whose identity depends entirely on this editor. It returns a pair list where the first entry is the actual returnable value, and the second is the user-enterable selectable display key.

Specified by:

choices in interface AbilityParameters.AbilityParmEditor

Returns:

key/display pairs

appliesToClass

public int appliesToClass(java.lang.Object o)

Description copied from interface: AbilityParameters.AbilityParmEditor

Returns how much this editor applies as the appropriate editor to the given object. A number less than 0 means it definitely doesn't apply. The higher the number, the more likely it is to be the correct edior.

Specified by:

appliesToClass in interface AbilityParameters.AbilityParmEditor

Parameters:

o - the object to check and see if this is an editor of

Returns:

a number denoting how likely it is that this is the editor.