Package com.planet_ink.coffee_mud.Libraries

Class Socials

java.lang.Object

com.planet_ink.coffee_mud.Libraries.StdLibrary

com.planet_ink.coffee_mud.Libraries.Socials

All Implemented Interfaces:

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

public class Socials
extends StdLibrary
implements SocialsList

Field Summary

Fields

Modifier and Type	Field	Description
java.lang.String	filename

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
Socials()

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.
protected java.util.List<Social>	enumSocialSet(int index)
Social	fetchSocial(java.lang.String fullSocialID, 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.
protected Social	fetchSocial(java.util.List<Social> socials, java.lang.String fullSocialID, boolean exactOnly)
protected Social	fetchSocial(java.util.List<Social> socials, java.lang.String targetCode, java.lang.String arg, boolean exactOnly)
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.
protected Social	fetchSocial(java.util.Map<java.lang.String,java.util.List<Social>> soc, java.lang.String baseName, Environmental targetE, java.lang.String arg, boolean exactOnly)
protected Social	fetchSocial(java.util.Map<java.lang.String,java.util.List<Social>> soc, java.lang.String baseName, java.lang.String target, java.lang.String arg, boolean exactOnly)
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.
protected java.lang.String	findSocialName(java.util.Map<java.lang.String,java.util.List<Social>> soc, java.lang.String named, boolean exactOnly)
java.util.Enumeration<Social>	getAllSocials()	Returns an enumeration of every social object, of every base name, and every target.
protected java.util.Map<java.lang.String,java.util.List<Social>>	getSocialHash()
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.
protected java.util.List<Social>	getSocialsSet(java.util.Map<java.lang.String,java.util.List<Social>> socialsMap, java.lang.String named, boolean exactOnly)
java.lang.String	ID()	The CoffeeMud Java Class ID shared by all instances of this object.
protected boolean	isLoaded()
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.
protected void	modifySocialOthersCode(MOB mob, Social me, int showNumber, int showFlag)
protected void	modifySocialSourceCode(MOB mob, Social me, int showNumber, int showFlag)
protected void	modifySocialTargetCode(MOB mob, Social me, int showNumber, int showFlag)
protected int	numSocialSets()
protected void	put(java.lang.String name, Social S)
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
protected static java.lang.String	replaceFirstWordStartsWith(java.lang.String str, java.lang.String thisStr, java.lang.String withThisStr)	Finds the first and only the first instance of the second parameter string in the first string, and replaces it with the third string.
void	save(MOB whom)	On behalf of the given mob, saves the cached socials to the default file in /resources/socials.txt
boolean	shutdown()	Shuts down the library.
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

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, tick

Field Detail

filename

public final java.lang.String filename

Constructor Detail

Socials

public Socials()

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

putSocialsInHash

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

Description copied from interface: SocialsList

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

Specified by:

putSocialsInHash in interface SocialsList

Parameters:

socialsMap - the map to put the socials into

lines - the lines to parse

Returns:

the number of socials added to hash

See Also:

SocialsList.fetchSocialFromSet(Map, List, boolean, boolean)

getSocialHash

protected java.util.Map<java.lang.String,java.util.List<Social>> getSocialHash()

isLoaded

protected boolean isLoaded()

put

protected void put(java.lang.String name,
                   Social S)

delSocial

public void delSocial(java.lang.String name)

Description copied from interface: SocialsList

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

Specified by:

delSocial in interface SocialsList

Parameters:

name - the full or partial/base social name

See Also:

SocialsList.addSocial(Social)

addSocial

public void addSocial(Social S)

Description copied from interface: SocialsList

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

Specified by:

addSocial in interface SocialsList

Parameters:

S - the social object

See Also:

SocialsList.delSocial(String)

numSocialSets

protected int numSocialSets()

unloadSocials

public void unloadSocials()

Description copied from interface: SocialsList

Unloads all the internally hashed socials for reloading later.

Specified by:

unloadSocials in interface SocialsList

shutdown

public boolean shutdown()

Description copied from interface: CMLibrary

Shuts down the library. Called at system shutdown time obviously, but is sometimes called just to reset the library.

Specified by:

shutdown in interface CMLibrary

Overrides:

shutdown in class StdLibrary

Returns:

true if shutdown was successful, false if there's nothing you can do about it

See Also:

CMLibrary.activate()

modifySocialOthersCode

protected void modifySocialOthersCode(MOB mob,
                                      Social me,
                                      int showNumber,
                                      int showFlag)
                               throws java.io.IOException

Throws:

java.io.IOException

modifySocialTargetCode

protected void modifySocialTargetCode(MOB mob,
                                      Social me,
                                      int showNumber,
                                      int showFlag)
                               throws java.io.IOException

Throws:

java.io.IOException

modifySocialSourceCode

protected void modifySocialSourceCode(MOB mob,
                                      Social me,
                                      int showNumber,
                                      int showFlag)
                               throws java.io.IOException

Throws:

java.io.IOException

replaceFirstWordStartsWith

protected static final java.lang.String replaceFirstWordStartsWith(java.lang.String str,
                                                                   java.lang.String thisStr,
                                                                   java.lang.String withThisStr)

Finds the first and only the first instance of the second parameter string in the first string, and replaces it with the third string. Returns the first string with or without changes. This method is case sensitive.

Parameters:

str - the string to look inside of

thisStr - the string to look for inside the first string

withThisStr - the string to replace the second string with, if found.

Returns:

the string modified, or not modified if no replacement was made.

modifySocialInterface

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

Description copied from interface: SocialsList

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

Specified by:

modifySocialInterface in interface SocialsList

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

protected Social fetchSocial(java.util.List<Social> socials,
                             java.lang.String targetCode,
                             java.lang.String arg,
                             boolean exactOnly)

fetchSocial

protected Social fetchSocial(java.util.List<Social> socials,
                             java.lang.String fullSocialID,
                             boolean exactOnly)

fetchSocial

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

Description copied from interface: SocialsList

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

Specified by:

fetchSocial in interface SocialsList

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:

SocialsList.fetchSocial(List, boolean, boolean), SocialsList.fetchSocial(String, boolean)

fetchSocial

protected Social fetchSocial(java.util.Map<java.lang.String,java.util.List<Social>> soc,
                             java.lang.String baseName,
                             Environmental targetE,
                             java.lang.String arg,
                             boolean exactOnly)

fetchSocial

public Social fetchSocial(java.lang.String fullSocialID,
                          boolean exactOnly)

Description copied from interface: SocialsList

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

Specified by:

fetchSocial in interface SocialsList

Parameters:

fullSocialID - 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:

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

fetchSocial

protected Social fetchSocial(java.util.Map<java.lang.String,java.util.List<Social>> soc,
                             java.lang.String baseName,
                             java.lang.String target,
                             java.lang.String arg,
                             boolean exactOnly)

fetchSocial

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

Description copied from interface: SocialsList

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

Specified by:

fetchSocial in interface SocialsList

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:

SocialsList.fetchSocial(String, Environmental, String, boolean), SocialsList.fetchSocial(String, boolean)

fetchSocialFromSet

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

Description copied from interface: SocialsList

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.

Specified by:

fetchSocialFromSet in interface SocialsList

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:

SocialsList.putSocialsInHash(Map, List)

enumSocialSet

protected java.util.List<Social> enumSocialSet(int index)

makeDefaultSocial

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

Description copied from interface: SocialsList

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.

Specified by:

makeDefaultSocial in interface SocialsList

Parameters:

name - baseName of the social to create

type - the target type, or ""

Returns:

the social object

save

public void save(MOB whom)

Description copied from interface: SocialsList

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

Specified by:

save in interface SocialsList

Parameters:

whom - the saver

getSocialsSet

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

Description copied from interface: SocialsList

Returns the social set of the given base name.

Specified by:

getSocialsSet in interface SocialsList

Parameters:

named - the social base name

Returns:

null, or the social set

findSocialBaseName

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

Description copied from interface: SocialsList

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

Specified by:

findSocialBaseName in interface SocialsList

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

getSocialsSet

protected java.util.List<Social> getSocialsSet(java.util.Map<java.lang.String,java.util.List<Social>> socialsMap,
                                               java.lang.String named,
                                               boolean exactOnly)

findSocialName

protected java.lang.String findSocialName(java.util.Map<java.lang.String,java.util.List<Social>> soc,
                                          java.lang.String named,
                                          boolean exactOnly)

getSocialsHelp

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

Description copied from interface: SocialsList

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

Specified by:

getSocialsHelp in interface SocialsList

Parameters:

mob - the viewer mob, or null

named - search base name

Returns:

null, or full info about social set

getSocialsBaseList

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

Description copied from interface: SocialsList

Returns a cached list of all social base names.

Specified by:

getSocialsBaseList in interface SocialsList

Returns:

a cached list of all social base names.

getAllSocials

public java.util.Enumeration<Social> getAllSocials()

Description copied from interface: SocialsList

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

Specified by:

getAllSocials in interface SocialsList

Returns:

a complete enumeration of every social object.

getSocialsBaseTable

public java.lang.String getSocialsBaseTable()

Description copied from interface: SocialsList

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

Specified by:

getSocialsBaseTable in interface SocialsList

Returns:

the list of social base names.