net.sourceforge.rpgee.dice
Interface RandomValueResultMapper

All Superinterfaces:

Describable

public interface RandomValueResultMapper
extends Describable

Field Summary

Fields inherited from interface net.sourceforge.rpgee.Describable

CODE_FOOTER, CODE_HEADER

Method Summary

int	getHighestMappableValue() The highest integer value that is mappable by this mapper
int	getLowestMappableValue() The lowest integer value that is mappable by this mapper
java.lang.String	getMappedValue(int value) Mappers map integer values to some string representation
boolean	isMappableValue(int value) Determines if a value can be mapped.

Methods inherited from interface net.sourceforge.rpgee.Describable

getDescription, getHTMLDescription

Method Detail

getMappedValue

java.lang.String getMappedValue(int value)
                                throws InvalidParameterException

Mappers map integer values to some string representation

Parameters:

value - integer value to map

Returns:

String map of the int value

Throws:

InvalidParameterException - if the value cannot be mapped (probably per isMappableValue)

isMappableValue

boolean isMappableValue(int value)

Determines if a value can be mapped. For fail-early processing, it just calls the getLowestMappableValue/getHigestMappableValue function

Parameters:

value -

Returns:

getLowestMappableValue

int getLowestMappableValue()

The lowest integer value that is mappable by this mapper

Returns:

lowest int value that can be mapped

getHighestMappableValue

int getHighestMappableValue()

The highest integer value that is mappable by this mapper

Returns:

highest int value that can be mapped