Package com.planet_ink.coffee_mud.Libraries.interfaces

Interface ListingLibrary

All Superinterfaces:

java.lang.Cloneable, CMLibrary, CMObject, java.lang.Comparable<CMObject>

All Known Implementing Classes:

CMLister

public interface ListingLibrary
extends CMLibrary

Providing data in a readable format is an important part of the user interface, especially for Archons who need access to charts and data for their work. Making such data and lists readable is the purpose of this library. This library does Not manage english syntax, or parsable data protocol strings, but charts and graph type tables.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ListingLibrary.ListStringer	An interface to provide a custom conversion from an arbitrary object type to a string, which might include String to String conversions.

Field Summary

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

idConverter

Method Summary

Modifier and Type	Method	Description
java.lang.String	build2ColTable(MOB viewerM, java.util.Enumeration<? extends java.lang.Object> these)	Given a viewer player mob from whose sessions the line wrap column will be used, and an enumeration of objects to show in a two-column table, this will convert the objects to ID (or class IDs) in a two column table.
java.lang.String	build2ColTable(MOB viewerM, java.util.Enumeration<? extends java.lang.Object> these, Filterer<java.lang.Object>[] filters, ListingLibrary.ListStringer stringer)	Given a viewer player mob from whose sessions the line wrap column will be used, an enumeration of objects to show in a two-column table, some optional filters to choose which objects and shown, and a ListStringer to convert the objects to strings, this will build the two-column table of strings.
java.lang.String	build3ColTable(MOB viewerM, java.util.Enumeration<? extends java.lang.Object> these)	Given a viewer player mob from whose sessions the line wrap column will be used, and an enumeration of objects whose IDs/class IDs will be the values, this will create a three-column table.
java.lang.String	build3ColTable(MOB viewerM, java.util.Enumeration<? extends java.lang.Object> these, Filterer<java.lang.Object>[] filters, ListingLibrary.ListStringer stringer)	Given a viewer player mob from whose sessions the line wrap column will be used, an enumeration of objects to show in a three-column table, some optional filters to choose which objects and shown, and a ListStringer to convert the objects to strings, this will build the three-column table of strings.
java.lang.String	build3ColTable(MOB viewerM, java.util.Enumeration<Ability> these, int ofType)	Given a viewer player mob from whose sessions the line wrap column will be used, and an enumeration of objects whose IDs/class IDs will be the values, this will create a three-column table.
java.lang.String	build3ColTable(MOB viewerM, java.util.Enumeration<Room> these, Room likeRoom)	Given a viewer player mob from whose sessions the line wrap column will be used, an enumeration of Room ID()s to show in a three-column table, and a room to use as a filter, showing only the objects whose area has the same name as the filter room, this will create a three-column table
java.lang.String	build3ColTable(MOB viewerM, java.util.List<java.lang.String> reverseList)	Given a viewer player mob from whose sessions the line wrap column will be used, and a list of identically classed strings, this will produce a table with the three columns.
java.lang.String	build3ColTable(MOB viewerM, java.util.List<java.lang.String> reverseList, java.lang.String tag)	Given a viewer player mob from whose sessions the line wrap column will be used, and a list of identically classed strings, this will produce a table with the three columns.
java.lang.String	build3ColTable(MOB viewerM, java.util.Map<java.lang.String,? extends java.lang.Object> these)	Given a viewer player mob from whose sessions the line wrap column will be used, and an map of object values whose IDs/class IDs will be the values, this will create a three-column table.
java.lang.String	build3ColTable(MOB viewerM, java.util.Map<java.lang.String,? extends java.lang.Object> these, Filterer<java.lang.Object>[] filters, ListingLibrary.ListStringer stringer)	Given a viewer player mob from whose sessions the line wrap column will be used, a map of Values to show in a three-column table, some optional filters to choose which objects and shown, and a ListStringer to convert the objects to strings, this will build the three-column table of strings taken only from the values of the map.
java.lang.String	build3ColTable(MOB viewerM, java.util.Map<java.lang.String,Ability> these, int ofType)	Given a viewer player mob from whose sessions the line wrap column will be used, and an map of Ability values whose IDs/class IDs will be the values, this will create a three-column table.
java.lang.String	build3ColTable(MOB viewerM, java.util.Map<java.lang.String,Room> these, Room likeRoom)	Given a viewer player mob from whose sessions the line wrap column will be used, a map of mapped room values whose ID()s show in a three-column table, and a room to use as a filter, showing only the objects whose area has the same name as the filter room, this will create a three-column table
java.lang.String	build3ColTable(MOB viewerM, java.util.Vector<? extends java.lang.Object> these)	Given a viewer player mob from whose sessions the line wrap column will be used, and a vector of objects whose IDs/class IDs will be the values, this will create a three-column table.
java.lang.String	build3ColTable(MOB viewerM, java.util.Vector<? extends java.lang.Object> these, Filterer<java.lang.Object>[] filters, ListingLibrary.ListStringer stringer)	Given a viewer player mob from whose sessions the line wrap column will be used, a vector of objects to show in a three-column table, some optional filters to choose which objects and shown, and a ListStringer to convert the objects to strings, this will build the three-column table of strings.
java.lang.String	build3ColTable(MOB viewerM, java.util.Vector<Ability> these, int ofType)	Given a viewer player mob from whose sessions the line wrap column will be used, and a vector of objects whose IDs/class IDs will be the values, this will create a three-column table.
java.lang.String	build3ColTable(MOB viewerM, java.util.Vector<Room> these, Room likeRoom)	Given a viewer player mob from whose sessions the line wrap column will be used, a vector of Room ID()s to show in a three-column table, and a room to use as a filter, showing only the objects whose area has the same name as the filter room, this will create a three-column table
java.lang.String	build4ColTable(MOB viewerM, java.util.List<java.lang.String> reverseList)	Given a viewer player mob from whose sessions the line wrap column will be used, and a list of identically classed strings, this will produce a table with the four columns.
java.lang.String	build4ColTable(MOB viewerM, java.util.List<java.lang.String> reverseList, java.lang.String tag)	Given a viewer player mob from whose sessions the line wrap column will be used, and a list of identically classed strings, this will produce a table with the four columns.
java.lang.String	buildNColTable(MOB viewerM, java.util.List<java.lang.String> reverseList, java.lang.String tag, int numCols)	Given a viewer player mob from whose sessions the line wrap column will be used, and a list of identically classed strings, this will produce a table with the given number of columns.
java.lang.String	buildWikiList(java.util.Enumeration<? extends CMObject> these, int ofType)	To support publishing CoffeeMud engine data to wiki's, this method exists to produce tables that conform to open-wiki type formats.
java.lang.String	buildWikiList(java.util.Enumeration<? extends CMObject> these, Filterer<java.lang.Object>[] filters, boolean includeName)	To support publishing CoffeeMud engine data to wiki's, this method exists to produce tables that conform to open-wiki type formats.
int	fixColWidth(double colWidth, double totalWidth)	Given a column width, which is expect to be a percent of 78, this method will scale the value according to the given user-preferred total wrap width.
int	fixColWidth(double colWidth, Session session)	Given a column width, which is expect to be a percent of 78, this method will scale the value according to the given session's user-preferred total wrap width.
int	fixColWidth(double colWidth, MOB mob)	Given a column width, which is expect to be a percent of 78, this method will scale the value according to the given mob's session's user-preferred total wrap width.
void	fixColWidths(int[] colWidths, Session session)	Given a set of column widths, which are expected to add up to 78, this method will scale the values of those widths according to the given sessions line width preferences.
ListingLibrary.ListStringer	getListStringer()	Returns a default ListStringer object-to-string converter that will return the class ID of the given object, unless it is an Ability, Class, or Race, in which case it returns the ID with an asterisk if it is generic.
java.lang.String	lister(MOB viewerM, java.util.List<? extends Environmental> items, boolean useName, java.lang.String tag, java.lang.String tagParm, boolean longLook, boolean compress)	Given a viewer player mob from whose sessions the line wrap column will be used, a list of items, mobs, or exits (usually), optional xml/html tags, and various flags to affect what property of the objects is shown, this will generate a single column list of the given things.

Methods inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.CMLibrary

activate, getServiceClient, L, propertiesLoaded, shutdown

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

copyOf, ID, initializeClass, name, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

lister

java.lang.String lister(MOB viewerM,
                        java.util.List<? extends Environmental> items,
                        boolean useName,
                        java.lang.String tag,
                        java.lang.String tagParm,
                        boolean longLook,
                        boolean compress)

Given a viewer player mob from whose sessions the line wrap column will be used, a list of items, mobs, or exits (usually), optional xml/html tags, and various flags to affect what property of the objects is shown, this will generate a single column list of the given things. Enforces maximum sized list.

Parameters:

viewerM - the player mob to use for session settings

items - the items, exits, mobs, whatever

useName - true to use names, false for display text

tag - null, or an optional tag to include

tagParm - null, * for item name, or thing to append to tag

longLook - true to bypass max, and shows container contents

compress - true to return paragraph, false is the normal list

Returns:

a list of things

build3ColTable

java.lang.String build3ColTable(MOB viewerM,
                                java.util.Map<java.lang.String,Ability> these,
                                int ofType)

Given a viewer player mob from whose sessions the line wrap column will be used, and an map of Ability values whose IDs/class IDs will be the values, this will create a three-column table. An optional domain/ability code filter is provided.

Parameters:

viewerM - the player mob to use for session settings

these - the objects whose IDs to show

ofType - -1, or a domain/ability type filter

Returns:

a three column table

See Also:

build3ColTable(MOB, Enumeration, int), build3ColTable(MOB, Vector, int)

build3ColTable

java.lang.String build3ColTable(MOB viewerM,
                                java.util.Vector<Ability> these,
                                int ofType)

Given a viewer player mob from whose sessions the line wrap column will be used, and a vector of objects whose IDs/class IDs will be the values, this will create a three-column table. An optional domain/ability code filter is provided.

Parameters:

viewerM - the player mob to use for session settings

these - the objects whose IDs to show

ofType - -1, or a domain/ability type filter

Returns:

a three column table

See Also:

build3ColTable(MOB, Enumeration, int), build3ColTable(MOB, Map, int)

build3ColTable

java.lang.String build3ColTable(MOB viewerM,
                                java.util.Enumeration<Ability> these,
                                int ofType)

Given a viewer player mob from whose sessions the line wrap column will be used, and an enumeration of objects whose IDs/class IDs will be the values, this will create a three-column table. An optional domain/ability code filter is provided.

Parameters:

viewerM - the player mob to use for session settings

these - the objects whose IDs to show

ofType - -1, or a domain/ability type filter

Returns:

a three column table

See Also:

build3ColTable(MOB, Vector, int), build3ColTable(MOB, Map, int)

build3ColTable

java.lang.String build3ColTable(MOB viewerM,
                                java.util.Map<java.lang.String,? extends java.lang.Object> these)

Given a viewer player mob from whose sessions the line wrap column will be used, and an map of object values whose IDs/class IDs will be the values, this will create a three-column table.

Parameters:

viewerM - the player mob to use for session settings

these - the objects whose IDs to show

Returns:

a three column table

See Also:

build3ColTable(MOB, Enumeration), build3ColTable(MOB, Vector)

build3ColTable

java.lang.String build3ColTable(MOB viewerM,
                                java.util.Vector<? extends java.lang.Object> these)

Given a viewer player mob from whose sessions the line wrap column will be used, and a vector of objects whose IDs/class IDs will be the values, this will create a three-column table.

Parameters:

viewerM - the player mob to use for session settings

these - the objects whose IDs to show

Returns:

a three column table

See Also:

build3ColTable(MOB, Enumeration), build3ColTable(MOB, Map)

build3ColTable

java.lang.String build3ColTable(MOB viewerM,
                                java.util.Enumeration<? extends java.lang.Object> these)

Given a viewer player mob from whose sessions the line wrap column will be used, and an enumeration of objects whose IDs/class IDs will be the values, this will create a three-column table.

Parameters:

viewerM - the player mob to use for session settings

these - the objects whose IDs to show

Returns:

a three column table

See Also:

build3ColTable(MOB, Vector), build3ColTable(MOB, Map)

build3ColTable

java.lang.String build3ColTable(MOB viewerM,
                                java.util.Map<java.lang.String,Room> these,
                                Room likeRoom)

Given a viewer player mob from whose sessions the line wrap column will be used, a map of mapped room values whose ID()s show in a three-column table, and a room to use as a filter, showing only the objects whose area has the same name as the filter room, this will create a three-column table

Parameters:

viewerM - the player mob to use for session settings

these - the map of room objects whose IDs to show

likeRoom - the room whose area serves as a filter

Returns:

a three column table

See Also:

build3ColTable(MOB, Enumeration, Room), build3ColTable(MOB, Vector, Room)

build3ColTable

java.lang.String build3ColTable(MOB viewerM,
                                java.util.Vector<Room> these,
                                Room likeRoom)

Given a viewer player mob from whose sessions the line wrap column will be used, a vector of Room ID()s to show in a three-column table, and a room to use as a filter, showing only the objects whose area has the same name as the filter room, this will create a three-column table

Parameters:

viewerM - the player mob to use for session settings

these - the list of room IDs to show

likeRoom - the room whose area serves as a filter

Returns:

a three column table

See Also:

build3ColTable(MOB, Enumeration, Room), build3ColTable(MOB, Map, Room)

build3ColTable

java.lang.String build3ColTable(MOB viewerM,
                                java.util.Enumeration<Room> these,
                                Room likeRoom)

Given a viewer player mob from whose sessions the line wrap column will be used, an enumeration of Room ID()s to show in a three-column table, and a room to use as a filter, showing only the objects whose area has the same name as the filter room, this will create a three-column table

Parameters:

viewerM - the player mob to use for session settings

these - the list of room IDs to show

likeRoom - the room whose area serves as a filter

Returns:

a three column table

See Also:

build3ColTable(MOB, Vector, Room), build3ColTable(MOB, Map, Room)

build3ColTable

java.lang.String build3ColTable(MOB viewerM,
                                java.util.Map<java.lang.String,? extends java.lang.Object> these,
                                Filterer<java.lang.Object>[] filters,
                                ListingLibrary.ListStringer stringer)

Given a viewer player mob from whose sessions the line wrap column will be used, a map of Values to show in a three-column table, some optional filters to choose which objects and shown, and a ListStringer to convert the objects to strings, this will build the three-column table of strings taken only from the values of the map.

Parameters:

viewerM - the player mob to use for session settings

these - the map of objects to show -- values only

filters - null, or filters to choose which objects to show

stringer - required object to string converter

Returns:

a three column table

See Also:

build3ColTable(MOB, Enumeration, Filterer[], ListStringer), build3ColTable(MOB, Vector, Filterer[], ListStringer)

build3ColTable

java.lang.String build3ColTable(MOB viewerM,
                                java.util.Vector<? extends java.lang.Object> these,
                                Filterer<java.lang.Object>[] filters,
                                ListingLibrary.ListStringer stringer)

Given a viewer player mob from whose sessions the line wrap column will be used, a vector of objects to show in a three-column table, some optional filters to choose which objects and shown, and a ListStringer to convert the objects to strings, this will build the three-column table of strings.

Parameters:

viewerM - the player mob to use for session settings

these - the list of objects to show

filters - null, or filters to choose which objects to show

stringer - required object to string converter

Returns:

a three column table

See Also:

build3ColTable(MOB, Enumeration, Filterer[], ListStringer), build3ColTable(MOB, Map, Filterer[], ListStringer)

build3ColTable

java.lang.String build3ColTable(MOB viewerM,
                                java.util.Enumeration<? extends java.lang.Object> these,
                                Filterer<java.lang.Object>[] filters,
                                ListingLibrary.ListStringer stringer)

Given a viewer player mob from whose sessions the line wrap column will be used, an enumeration of objects to show in a three-column table, some optional filters to choose which objects and shown, and a ListStringer to convert the objects to strings, this will build the three-column table of strings.

Parameters:

viewerM - the player mob to use for session settings

these - the list of objects to show

filters - null, or filters to choose which objects to show

stringer - required object to string converter

Returns:

a three column table

See Also:

build3ColTable(MOB, Map, Filterer[], ListStringer), build3ColTable(MOB, Vector, Filterer[], ListStringer)

build2ColTable

java.lang.String build2ColTable(MOB viewerM,
                                java.util.Enumeration<? extends java.lang.Object> these)

Given a viewer player mob from whose sessions the line wrap column will be used, and an enumeration of objects to show in a two-column table, this will convert the objects to ID (or class IDs) in a two column table.

Parameters:

viewerM - the player mob to use for session settings

these - the list of objects to show

Returns:

a two column table

See Also:

build2ColTable(MOB, Enumeration, Filterer[], ListStringer)

build2ColTable

java.lang.String build2ColTable(MOB viewerM,
                                java.util.Enumeration<? extends java.lang.Object> these,
                                Filterer<java.lang.Object>[] filters,
                                ListingLibrary.ListStringer stringer)

Given a viewer player mob from whose sessions the line wrap column will be used, an enumeration of objects to show in a two-column table, some optional filters to choose which objects and shown, and a ListStringer to convert the objects to strings, this will build the two-column table of strings.

Parameters:

viewerM - the player mob to use for session settings

these - the list of objects to show

filters - null, or filters to choose which objects to show

stringer - required object to string converter

Returns:

a two column table

See Also:

build2ColTable(MOB, Enumeration)

buildWikiList

java.lang.String buildWikiList(java.util.Enumeration<? extends CMObject> these,
                               Filterer<java.lang.Object>[] filters,
                               boolean includeName)

To support publishing CoffeeMud engine data to wiki's, this method exists to produce tables that conform to open-wiki type formats. One or more filters can be sent to choose which objects are shown. The ID of each object is shown, unless the name is requested.

Parameters:

these - an enumeration of objects to make a table from

filters - filters to choose which objects can be shown

includeName - true to show the name, false to use the ID

Returns:

the wiki table

See Also:

buildWikiList(Enumeration, int)

buildWikiList

java.lang.String buildWikiList(java.util.Enumeration<? extends CMObject> these,
                               int ofType)

To support publishing CoffeeMud engine data to wiki's, this method exists to produce tables that conform to open-wiki type formats. The name() of each object is shown. For Abilities, a filter for the domain and ability type can be sent.

Parameters:

these - an enumeration of objects to make a table from

ofType - -1, or a domain/ability type filter

Returns:

the wiki table

See Also:

buildWikiList(Enumeration, int)

build4ColTable

java.lang.String build4ColTable(MOB viewerM,
                                java.util.List<java.lang.String> reverseList)

Given a viewer player mob from whose sessions the line wrap column will be used, and a list of identically classed strings, this will produce a table with the four columns.

Parameters:

viewerM - the player mob to use for session settings

reverseList - the list of strings to make a columned list from

Returns:

the full table

See Also:

build4ColTable(MOB, List), build4ColTable(MOB, List, String), build3ColTable(MOB, List), build3ColTable(MOB, List, String), buildNColTable(MOB, List, String, int)

build4ColTable

java.lang.String build4ColTable(MOB viewerM,
                                java.util.List<java.lang.String> reverseList,
                                java.lang.String tag)

Given a viewer player mob from whose sessions the line wrap column will be used, and a list of identically classed strings, this will produce a table with the four columns. An optional xml/html tag can wrap the values.

Parameters:

viewerM - the player mob to use for session settings

reverseList - the list of strings to make a columned list from

tag - null, or a tag to wrap the string in

Returns:

the full table

See Also:

build4ColTable(MOB, List), build4ColTable(MOB, List, String), build3ColTable(MOB, List), build3ColTable(MOB, List, String), buildNColTable(MOB, List, String, int)

build3ColTable

java.lang.String build3ColTable(MOB viewerM,
                                java.util.List<java.lang.String> reverseList)

Given a viewer player mob from whose sessions the line wrap column will be used, and a list of identically classed strings, this will produce a table with the three columns.

Parameters:

viewerM - the player mob to use for session settings

reverseList - the list of strings to make a columned list from

Returns:

the full table

See Also:

build4ColTable(MOB, List), build4ColTable(MOB, List, String), build3ColTable(MOB, List), build3ColTable(MOB, List, String), buildNColTable(MOB, List, String, int)

build3ColTable

java.lang.String build3ColTable(MOB viewerM,
                                java.util.List<java.lang.String> reverseList,
                                java.lang.String tag)

Given a viewer player mob from whose sessions the line wrap column will be used, and a list of identically classed strings, this will produce a table with the three columns. An optional xml/html tag can wrap the values.

Parameters:

viewerM - the player mob to use for session settings

reverseList - the list of strings to make a columned list from

tag - null, or a tag to wrap the string in

Returns:

the full table

See Also:

build4ColTable(MOB, List), build4ColTable(MOB, List, String), build3ColTable(MOB, List), build3ColTable(MOB, List, String), buildNColTable(MOB, List, String, int)

buildNColTable

java.lang.String buildNColTable(MOB viewerM,
                                java.util.List<java.lang.String> reverseList,
                                java.lang.String tag,
                                int numCols)

Given a viewer player mob from whose sessions the line wrap column will be used, and a list of identically classed strings, this will produce a table with the given number of columns. An optional xml/html tag can wrap the values.

Parameters:

viewerM - the player mob to use for session settings

reverseList - the list of strings to make a columned list from

tag - null, or a tag to wrap the string in

numCols - the number of columns to put the data into

Returns:

the full table

See Also:

build4ColTable(MOB, List), build4ColTable(MOB, List, String), build3ColTable(MOB, List), build3ColTable(MOB, List, String), buildNColTable(MOB, List, String, int)

getListStringer

ListingLibrary.ListStringer getListStringer()

Returns a default ListStringer object-to-string converter that will return the class ID of the given object, unless it is an Ability, Class, or Race, in which case it returns the ID with an asterisk if it is generic.

Returns:

default ListStringer

See Also:

ListingLibrary.ListStringer

fixColWidth

int fixColWidth(double colWidth,
                MOB mob)

Given a column width, which is expect to be a percent of 78, this method will scale the value according to the given mob's session's user-preferred total wrap width.

Parameters:

colWidth - the column width of 78

mob - the mob to take the session wrap from

Returns:

the new column width

See Also:

Session.getWrap(), fixColWidth(double, double), fixColWidth(double, Session), fixColWidths(int[], Session)

fixColWidth

int fixColWidth(double colWidth,
                Session session)

Given a column width, which is expect to be a percent of 78, this method will scale the value according to the given session's user-preferred total wrap width.

Parameters:

colWidth - the column width of 78

session - the session to get wrap length from

Returns:

the new column width

See Also:

Session.getWrap(), fixColWidth(double, double), fixColWidth(double, MOB), fixColWidths(int[], Session)

fixColWidth

int fixColWidth(double colWidth,
                double totalWidth)

Given a column width, which is expect to be a percent of 78, this method will scale the value according to the given user-preferred total wrap width.

Parameters:

colWidth - the column width of 78

totalWidth - the new total width (not 78)

Returns:

the new column width

See Also:

Session.getWrap(), fixColWidth(double, MOB), fixColWidth(double, Session), fixColWidths(int[], Session)

fixColWidths

void fixColWidths(int[] colWidths,
                  Session session)

Given a set of column widths, which are expected to add up to 78, this method will scale the values of those widths according to the given sessions line width preferences.

Parameters:

colWidths - the column widths

session - the session to get wrap length from

See Also:

Session.getWrap(), fixColWidth(double, double), fixColWidth(double, MOB), fixColWidth(double, Session)