Package com.planet_ink.coffee_mud.Libraries.interfaces

Interface SocialsList

All Superinterfaces:

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

All Known Implementing Classes:

Socials

public interface SocialsList
extends CMLibrary

Collection manager for all the socials in the game, with utility functions for dealing with external socials as well. A social set is a set of social object with the same base name, so SMILE, SMILE T-NAME, SMILE ALL, etc. would all be part of the same social set of the base name "SMILE".

Field Summary

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

idConverter

Method Summary

Modifier and Type	Method	Description
void	addSocial(Social S)	Adds a single social target to its cached set in this collection/manager.
void	delSocial(java.lang.String name)	Removes the entire social set of the given name, including all of its variations.
Social	fetchSocial(java.lang.String name, boolean exactOnly)	Given a full social id, this will return the Social object, either matching exactly, or doing a softer search.
Social	fetchSocial(java.lang.String baseName, Environmental targetE, java.lang.String arg, boolean exactOnly)	Given a potential social name, a target object, and a possible trailing arg, this will find and return the social that matches.
Social	fetchSocial(java.util.List<java.lang.String> commands, boolean exactOnly, boolean checkItemTargets)	Given a parsed user command line entry, this will search the socials for a likely social object match, and return it.
Social	fetchSocialFromSet(java.util.Map<java.lang.String,java.util.List<Social>> socialsMap, java.util.List<java.lang.String> commands, boolean exactOnly, boolean checkItemTargets)	Given an external map of base names to social sets, and a parsed command line from a user, this will attempt to find if one of the socials appears in the map, and return it.
java.lang.String	findSocialBaseName(java.lang.String named, boolean exactOnly)	Given a social name to match, it will search for and return the base name.
java.util.Enumeration<Social>	getAllSocials()	Returns an enumeration of every social object, of every base name, and every target.
java.util.List<java.lang.String>	getSocialsBaseList()	Returns a cached list of all social base names.
java.lang.String	getSocialsBaseTable()	Creates 4 column list of all social base names.
java.lang.String	getSocialsHelp(MOB mob, java.lang.String named)	Gets the full details on every target variation of the social set with the given name, for the given mob viewer.
java.util.List<Social>	getSocialsSet(java.lang.String named)	Returns the social set of the given base name.
Social	makeDefaultSocial(java.lang.String name, java.lang.String type)	Create a default social object of the given base name, and the given target type, such as ALL, S-NAME, SELF, etc.
boolean	modifySocialInterface(MOB mob, java.util.List<Social> socials, java.lang.String name, java.lang.String rest)	Provides the entire command line editor for creating or modifying a social set.
int	putSocialsInHash(java.util.Map<java.lang.String,java.util.List<Social>> socialsMap, java.util.List<java.lang.String> lines)	Given a private map of base social names to social sets, this will populate that map from a list of parseable social lines, where the format is: 12\tID\tYouSee\tOthersSee\tTargetSees\tNoTargetSees\tMSP filename\tZappermask\t 1 = source code, 2 = others/target code
void	save(MOB whom)	On behalf of the given mob, saves the cached socials to the default file in /resources/socials.txt
void	unloadSocials()	Unloads all the internally hashed socials for reloading later.

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

delSocial

void delSocial(java.lang.String name)

Removes the entire social set of the given name, including all of its variations.

Parameters:

name - the full or partial/base social name

See Also:

addSocial(Social)

addSocial

void addSocial(Social S)

Adds a single social target to its cached set in this collection/manager.

Parameters:

S - the social object

See Also:

delSocial(String)

modifySocialInterface

boolean modifySocialInterface(MOB mob,
                              java.util.List<Social> socials,
                              java.lang.String name,
                              java.lang.String rest)
                       throws java.io.IOException

Provides the entire command line editor for creating or modifying a social set.

Parameters:

mob - the mob editor

socials - the social id or base name

name - the social name

rest - any extra terms used from command line

Returns:

true if something was done

Throws:

java.io.IOException - any i/o errors that occured, usually disconnect

fetchSocial

Social fetchSocial(java.lang.String name,
                   boolean exactOnly)

Given a full social id, this will return the Social object, either matching exactly, or doing a softer search.

Parameters:

name - the full social id, with base name and target

exactOnly - true for exact match, or false for search

Returns:

null, or the Social object

See Also:

fetchSocial(List, boolean, boolean), fetchSocial(String, Environmental, String, boolean)

fetchSocial

Social fetchSocial(java.lang.String baseName,
                   Environmental targetE,
                   java.lang.String arg,
                   boolean exactOnly)

Given a potential social name, a target object, and a possible trailing arg, this will find and return the social that matches.

Parameters:

baseName - the hopeful social base name

targetE - the target representing the social target

arg - a remaining argument, or ""

exactOnly - true for exact social match, or false for looser

Returns:

the found social object, or null

See Also:

fetchSocial(List, boolean, boolean), fetchSocial(String, boolean)

fetchSocial

Social fetchSocial(java.util.List<java.lang.String> commands,
                   boolean exactOnly,
                   boolean checkItemTargets)

Given a parsed user command line entry, this will search the socials for a likely social object match, and return it.

Parameters:

commands - the parsed user command line

exactOnly - true for exact base name match only

checkItemTargets - true to consider I-NAME target socials

Returns:

null, or the found social.

See Also:

fetchSocial(String, Environmental, String, boolean), fetchSocial(String, boolean)

findSocialBaseName

java.lang.String findSocialBaseName(java.lang.String named,
                                    boolean exactOnly)

Given a social name to match, it will search for and return the base name.

Parameters:

named - the whole or partial or full social name of it

exactOnly - true for exact base name match

Returns:

null, or the base social name

fetchSocialFromSet

Social fetchSocialFromSet(java.util.Map<java.lang.String,java.util.List<Social>> socialsMap,
                          java.util.List<java.lang.String> commands,
                          boolean exactOnly,
                          boolean checkItemTargets)

Given an external map of base names to social sets, and a parsed command line from a user, this will attempt to find if one of the socials appears in the map, and return it.

Parameters:

socialsMap - the map of base names to social sets

commands - the parsed user command line

exactOnly - true for only perfect exact matches

checkItemTargets - true to check I-NAME type targets

Returns:

null, or the matching social

See Also:

putSocialsInHash(Map, List)

putSocialsInHash

int putSocialsInHash(java.util.Map<java.lang.String,java.util.List<Social>> socialsMap,
                     java.util.List<java.lang.String> lines)

Given a private map of base social names to social sets, this will populate that map from a list of parseable social lines, where the format is: 12\tID\tYouSee\tOthersSee\tTargetSees\tNoTargetSees\tMSP filename\tZappermask\t 1 = source code, 2 = others/target code

Parameters:

socialsMap - the map to put the socials into

lines - the lines to parse

Returns:

the number of socials added to hash

See Also:

fetchSocialFromSet(Map, List, boolean, boolean)

getSocialsSet

java.util.List<Social> getSocialsSet(java.lang.String named)

Returns the social set of the given base name.

Parameters:

named - the social base name

Returns:

null, or the social set

getAllSocials

java.util.Enumeration<Social> getAllSocials()

Returns an enumeration of every social object, of every base name, and every target. All of the cached and managed socials.

Returns:

a complete enumeration of every social object.

save

void save(MOB whom)

On behalf of the given mob, saves the cached socials to the default file in /resources/socials.txt

Parameters:

whom - the saver

getSocialsBaseList

java.util.List<java.lang.String> getSocialsBaseList()

Returns a cached list of all social base names.

Returns:

a cached list of all social base names.

getSocialsHelp

java.lang.String getSocialsHelp(MOB mob,
                                java.lang.String named)

Gets the full details on every target variation of the social set with the given name, for the given mob viewer.

Parameters:

mob - the viewer mob, or null

named - search base name

Returns:

null, or full info about social set

getSocialsBaseTable

java.lang.String getSocialsBaseTable()

Creates 4 column list of all social base names. Keeps a resource cache as well.

Returns:

the list of social base names.

makeDefaultSocial

Social makeDefaultSocial(java.lang.String name,
                         java.lang.String type)

Create a default social object of the given base name, and the given target type, such as ALL, S-NAME, SELF, etc. This represents only one social target total.

Parameters:

name - baseName of the social to create

type - the target type, or ""

Returns:

the social object

unloadSocials

void unloadSocials()

Unloads all the internally hashed socials for reloading later.