Package com.planet_ink.coffee_mud.Libraries

Class CMLister

java.lang.Object

com.planet_ink.coffee_mud.Libraries.StdLibrary

com.planet_ink.coffee_mud.Libraries.CMLister

All Implemented Interfaces:

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

public class CMLister
extends StdLibrary
implements ListingLibrary

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	CMLister.AbilityTypeFilter
protected static class	CMLister.LikeRoomFilter

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.ListingLibrary

ListingLibrary.ListStringer

Field Summary

Fields

Modifier and Type	Field	Description
protected static Filterer<java.lang.Object>[]	NO_FILTER
protected static ListingLibrary.ListStringer	stringer

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

idConverter

Fields inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary

isDebugging, name, serviceClient, tickStatus

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

STATUS_AFFECT, STATUS_ALIVE, STATUS_BEHAVIOR, STATUS_CLASS, STATUS_DEAD, STATUS_END, STATUS_FIGHT, STATUS_MISC, STATUS_MISC2, STATUS_MISC3, STATUS_MISC4, STATUS_MISC5, STATUS_MISC6, STATUS_MISC7, STATUS_NOT, STATUS_OTHER, STATUS_RACE, STATUS_REBIRTH, STATUS_SCRIPT, STATUS_START, STATUS_WEATHER, TICKID_AREA, TICKID_BALLISTICK, TICKID_CLAN, TICKID_CLANITEM, TICKID_DEADBODY_DECAY, TICKID_ELECTRONICS, TICKID_EMAIL, TICKID_EVENT, TICKID_EXIT_BEHAVIOR, TICKID_EXIT_REOPEN, TICKID_ITEM_BEHAVIOR, TICKID_ITEM_BOUNCEBACK, TICKID_LIGHT_FLICKERS, TICKID_LIVEAUCTION, TICKID_LONGERMASK, TICKID_MISCELLANEOUS, TICKID_MOB, TICKID_PROPERTY_SPECIAL, TICKID_QUEST, TICKID_READYTOSTOP, TICKID_ROOM_BEHAVIOR, TICKID_ROOM_ITEM_REJUV, TICKID_SHORTERMASK, TICKID_SOLITARYMASK, TICKID_SPECIALCOMBAT, TICKID_SPECIALMANEUVER, TICKID_SPELL_AFFECT, TICKID_SUPPORT, TICKID_TIMEAUCTION, TICKID_TRAP_DESTRUCTION, TICKID_TRAP_RESET

Constructor Summary

Constructors

Constructor	Description
CMLister()

Method Summary

Modifier and Type	Method	Description
protected void	appendReps(int reps, java.lang.StringBuilder say, boolean compress)
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.
protected Filterer<java.lang.Object>[]	buildLikeRoomFilter(Room R)
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.
protected Filterer<java.lang.Object>[]	buildOfTypeFilter(int ofType)
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.
protected int	getReps(MOB viewerM, Environmental item, java.util.List<? extends Environmental> theRest, boolean useName, boolean longLook)
java.lang.String	ID()	The CoffeeMud Java Class ID shared by all instances of this object.
protected java.lang.String	itemSeenString(MOB viewerM, Environmental item, boolean useName, boolean longLook, boolean sysmsgs, boolean compress)
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.
java.lang.String	summarizeTheRest(MOB viewerM, java.util.List<? extends Environmental> things, boolean compress)

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, initializeClass, name, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from class java.lang.Object

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

Methods inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary

activate, checkDatabase, compareTo, copyOf, getServiceClient, getTickStatus, initializeClass, L, name, newInstance, propertiesLoaded, setThreadStatus, shutdown, tick

Field Detail

NO_FILTER

protected static final Filterer<java.lang.Object>[] NO_FILTER

stringer

protected static final ListingLibrary.ListStringer stringer

Constructor Detail

CMLister

public CMLister()

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

Overrides:

ID in class StdLibrary

Returns:

the name of this class

getListStringer

public ListingLibrary.ListStringer getListStringer()

Description copied from interface: ListingLibrary

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.

Specified by:

getListStringer in interface ListingLibrary

Returns:

default ListStringer

See Also:

ListingLibrary.ListStringer

itemSeenString

protected java.lang.String itemSeenString(MOB viewerM,
                                          Environmental item,
                                          boolean useName,
                                          boolean longLook,
                                          boolean sysmsgs,
                                          boolean compress)

getReps

protected int getReps(MOB viewerM,
                      Environmental item,
                      java.util.List<? extends Environmental> theRest,
                      boolean useName,
                      boolean longLook)

appendReps

protected void appendReps(int reps,
                          java.lang.StringBuilder say,
                          boolean compress)

summarizeTheRest

public java.lang.String summarizeTheRest(MOB viewerM,
                                         java.util.List<? extends Environmental> things,
                                         boolean compress)

lister

public 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)

Description copied from interface: ListingLibrary

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.

Specified by:

lister in interface ListingLibrary

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

buildOfTypeFilter

protected Filterer<java.lang.Object>[] buildOfTypeFilter(int ofType)

buildLikeRoomFilter

protected Filterer<java.lang.Object>[] buildLikeRoomFilter(Room R)

build3ColTable

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

Description copied from interface: ListingLibrary

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.

Specified by:

build3ColTable in interface ListingLibrary

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:

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

build3ColTable

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

Description copied from interface: ListingLibrary

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.

Specified by:

build3ColTable in interface ListingLibrary

Parameters:

viewerM - the player mob to use for session settings

these - the objects whose IDs to show

Returns:

a three column table

See Also:

ListingLibrary.build3ColTable(MOB, Enumeration), ListingLibrary.build3ColTable(MOB, Vector)

build3ColTable

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

Description copied from interface: ListingLibrary

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

Specified by:

build3ColTable in interface ListingLibrary

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:

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

build3ColTable

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

Description copied from interface: ListingLibrary

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.

Specified by:

build3ColTable in interface ListingLibrary

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:

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

build3ColTable

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

Description copied from interface: ListingLibrary

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.

Specified by:

build3ColTable in interface ListingLibrary

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:

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

build3ColTable

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

Description copied from interface: ListingLibrary

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.

Specified by:

build3ColTable in interface ListingLibrary

Parameters:

viewerM - the player mob to use for session settings

these - the objects whose IDs to show

Returns:

a three column table

See Also:

ListingLibrary.build3ColTable(MOB, Enumeration), ListingLibrary.build3ColTable(MOB, Map)

build3ColTable

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

Description copied from interface: ListingLibrary

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.

Specified by:

build3ColTable in interface ListingLibrary

Parameters:

viewerM - the player mob to use for session settings

these - the objects whose IDs to show

Returns:

a three column table

See Also:

ListingLibrary.build3ColTable(MOB, Vector), ListingLibrary.build3ColTable(MOB, Map)

build3ColTable

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

Description copied from interface: ListingLibrary

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

Specified by:

build3ColTable in interface ListingLibrary

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:

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

build3ColTable

public 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)

Description copied from interface: ListingLibrary

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.

Specified by:

build3ColTable in interface ListingLibrary

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:

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

build3ColTable

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

Description copied from interface: ListingLibrary

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.

Specified by:

build3ColTable in interface ListingLibrary

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:

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

build3ColTable

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

Description copied from interface: ListingLibrary

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

Specified by:

build3ColTable in interface ListingLibrary

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:

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

build3ColTable

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

Description copied from interface: ListingLibrary

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.

Specified by:

build3ColTable in interface ListingLibrary

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:

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

buildWikiList

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

Description copied from interface: ListingLibrary

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.

Specified by:

buildWikiList in interface ListingLibrary

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:

ListingLibrary.buildWikiList(Enumeration, int)

buildWikiList

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

Description copied from interface: ListingLibrary

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.

Specified by:

buildWikiList in interface ListingLibrary

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:

ListingLibrary.buildWikiList(Enumeration, int)

build2ColTable

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

Description copied from interface: ListingLibrary

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.

Specified by:

build2ColTable in interface ListingLibrary

Parameters:

viewerM - the player mob to use for session settings

these - the list of objects to show

Returns:

a two column table

See Also:

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

build2ColTable

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

Description copied from interface: ListingLibrary

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.

Specified by:

build2ColTable in interface ListingLibrary

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:

ListingLibrary.build2ColTable(MOB, Enumeration)

build4ColTable

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

Description copied from interface: ListingLibrary

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.

Specified by:

build4ColTable in interface ListingLibrary

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:

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

build4ColTable

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

Description copied from interface: ListingLibrary

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.

Specified by:

build4ColTable in interface ListingLibrary

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:

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

build3ColTable

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

Description copied from interface: ListingLibrary

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.

Specified by:

build3ColTable in interface ListingLibrary

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:

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

build3ColTable

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

Description copied from interface: ListingLibrary

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.

Specified by:

build3ColTable in interface ListingLibrary

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:

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

fixColWidth

public int fixColWidth(double colWidth,
                       MOB mob)

Description copied from interface: ListingLibrary

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.

Specified by:

fixColWidth in interface ListingLibrary

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(), ListingLibrary.fixColWidth(double, double), ListingLibrary.fixColWidth(double, Session), ListingLibrary.fixColWidths(int[], Session)

fixColWidth

public int fixColWidth(double colWidth,
                       Session session)

Description copied from interface: ListingLibrary

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.

Specified by:

fixColWidth in interface ListingLibrary

Parameters:

colWidth - the column width of 78

session - the session to get wrap length from

Returns:

the new column width

See Also:

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

fixColWidths

public void fixColWidths(int[] colWidths,
                         Session session)

Description copied from interface: ListingLibrary

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.

Specified by:

fixColWidths in interface ListingLibrary

Parameters:

colWidths - the column widths

session - the session to get wrap length from

See Also:

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

fixColWidth

public int fixColWidth(double colWidth,
                       double totalWidth)

Description copied from interface: ListingLibrary

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.

Specified by:

fixColWidth in interface ListingLibrary

Parameters:

colWidth - the column width of 78

totalWidth - the new total width (not 78)

Returns:

the new column width

See Also:

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

buildNColTable

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

Description copied from interface: ListingLibrary

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.

Specified by:

buildNColTable in interface ListingLibrary

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:

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