EnglishParser

java.lang.Object
- com.planet_ink.coffee_mud.Libraries.StdLibrary
- - com.planet_ink.coffee_mud.Libraries.EnglishParser

All Implemented Interfaces:

CMObject, Tickable, CMLibrary, EnglishParsing, java.lang.Cloneable, java.lang.Comparable<CMObject>
```
public class EnglishParser
extends StdLibrary
implements EnglishParsing
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

protected static class EnglishParser.FetchFlags

Nested Classes
Modifier and Type	Class	Description
`protected static class`	`EnglishParser.FetchFlags`

Field Summary

Fields
Modifier and Type	Field	Description
`static char[]`	`ALL_CHRS`
`static java.lang.String[]`	`ARTICLES`
`static java.util.List<Environmental>`	`empty`
`static java.lang.String[]`	`feewords1`
`static java.lang.String[]`	`feewords2`
`static java.lang.String[]`	`fnouns`
`static java.lang.String[]`	`frwords`
`static java.lang.String[]`	`fwords`
`static java.lang.String[]`	`INDARTICLES`
`static boolean[]`	`NARROW_PUNCTUATION_TABLE`
`static java.lang.String[]`	`num_words`
`static java.lang.String[]`	`num_words_10`
`static java.lang.String[]`	`num_words_x`
`static java.lang.String[]`	`numth_words`
`static boolean[]`	`PUNCTUATION_TABLE`

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

EnglishParser()

Constructors
Constructor	Description
`EnglishParser()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`bumpDotContextNumber(java.lang.String srchStr, int thisMuch)`	Given a context-specific name, this method returns the name with the number adjusted according to the given amount.
`protected java.lang.String`	`cleanExtraneousDollarMarkers(java.lang.String srchStr)`
`java.lang.String`	`cleanPrepositions(java.lang.String s)`	If the given phrase begins with a preposition word such as to, over, beside, than, since, it will strip the word off and return the rest of the string.
`protected java.lang.String`	`collapsedName(Ability thisAbility)`
`boolean`	`containsOneOfString(java.lang.String toSrchStr, java.util.List<java.lang.String> srchForStrs)`	Returns whether the given string contains any of the srchForStr substrings.
`boolean`	`containsString(java.lang.String toSrchStr, java.lang.String srchForStr)`	Returns whether the first string contains the second, case insensitive, and color insensitive.
`java.lang.String`	`coordDescShort(long[] coords)`	Returns [best distance],[best distance],[best distance] A [best distance] picks the best of dm, km, etc..
`java.lang.String`	`directionDescShort(double[] dir)`	Returns direction in [degrees.YY] mark [degrees.YY]
`java.lang.String`	`directionDescShortest(double[] dir)`	Returns direction in [degrees.Y] [space] [degrees.Y]
`java.lang.String`	`distanceDescShort(long distance)`	Returns [best distance] for the given number.
`boolean`	`equalsPunctuationless(char[] strC, char[] str2C)`
`protected boolean`	`evokedBy(Ability thisAbility, java.lang.String thisWord)`
`protected boolean`	`evokedBy(Ability thisAbility, java.lang.String thisWord, java.lang.String secondWord)`
`Environmental`	`fetchAvailable(java.util.Collection<? extends Environmental> list, java.lang.String srchStr, Item goodLocation, Filterer<Environmental> filter, boolean exactOnly)`	Returns a matching environmental object from a collection of them by using a search string to matching, a required filter, and for items, a container which may be null.
`Environmental`	`fetchAvailable(java.util.Collection<? extends Environmental> list, java.lang.String srchStr, Item goodLocation, Filterer<Environmental> filter, boolean exactOnly, int[] counterSlap)`	Returns a matching environmental object from a collection of them by using a search string to matching, a required filter, and for items, a container which may be null.
`Item`	`fetchAvailableItem(java.util.List<Item> list, java.lang.String srchStr, Item goodLocation, Filterer<Environmental> filter, boolean exactOnly)`	Returns a matching item from a collection of them by using a search string to matching, a required filter, and a container which may be null.
`java.util.List<Item>`	`fetchAvailableItems(java.util.List<Item> list, java.lang.String srchStr, Item goodLocation, Filterer<Environmental> filter, boolean exactOnly)`	Returns a set of matching items from a collection of them by using a search string to matching, a required filter, and a container which may be null.
`Environmental`	`fetchEnvironmental(java.lang.Iterable<? extends Environmental> list, java.lang.String srchStr, boolean exactOnly)`	Returns a matching environmental object from an iterable collection of them by using a search string to matching.
`Environmental`	`fetchEnvironmental(java.util.Enumeration<? extends Environmental> iter, java.lang.String srchStr, boolean exactOnly)`	Returns a matching environmental object from an enumeration of them by using a search string to matching.
`Environmental`	`fetchEnvironmental(java.util.Iterator<? extends Environmental> iter, java.lang.String srchStr, boolean exactOnly)`	Returns a matching environmental object from an iterator of them by using a search string to matching.
`Environmental`	`fetchEnvironmental(java.util.Map<java.lang.String,? extends Environmental> list, java.lang.String srchStr, boolean exactOnly)`	Returns a matching environmental object from map of them by using a search string to matching.
`java.util.List<Environmental>`	`fetchEnvironmentals(java.util.List<? extends Environmental> list, java.lang.String srchStr, boolean exactOnly)`	Returns a set of matching environmental objects from a collection of them by using a search string to matching.
`Exit`	`fetchExit(java.lang.Iterable<? extends Environmental> list, java.lang.String srchStr, boolean exactOnly)`	Returns a matching exit object from an iterable collection of them by using a search string to matching.
`EnglishParser.FetchFlags`	`fetchFlags(java.lang.String srchStr)`
`java.util.List<Item>`	`fetchItemList(ItemPossessor from, MOB mob, Item container, java.util.List<java.lang.String> matchWords, Filterer<Environmental> filter, boolean visionMatters)`	Returns a set of matching items from a given item possessor.
`<T> T`	`fetchReflective(java.lang.Iterable<T> list, java.lang.String srchStr, java.lang.String methodName, boolean exactOnly)`	Returns a matching T object from an iterable collection of them by using a search string to matching.
`CMObject`	`findCommand(MOB mob, java.util.List<java.lang.String> commands)`	Given a user input array, this method will find the skill, command, social, channel, or journal that is trying to be invoked by the user input and, if found, return it.
`Social`	`findSocial(MOB mob, java.util.List<java.lang.String> commands, boolean exactOnly)`
`java.util.List<java.lang.String>`	`getAllContextNames(java.util.Collection<? extends Environmental> list, Filterer<Environmental> filter)`	Given a list of objects and an optional filter, this method returns a list of identical size and order, with the context-specific names instead of the objects.
`protected java.lang.String`	`getBestDistance(long d)`
`int`	`getContextDotNumber(java.lang.String srchStr)`	Returns the context number of the given context-specific name.
`java.lang.String`	`getContextName(Environmental[] list, Environmental E)`	Returns the context-qualified name of the item in the given list is exactly the given environmental.
`java.lang.String`	`getContextName(ItemCollection cont, Environmental E)`	Returns the context-qualified name of the item in the given collection is exactly the given environmental.
`java.lang.String`	`getContextName(java.util.Collection<? extends Environmental> list, Environmental E)`	Returns the context-qualified name of the item in the given collection is exactly the given environmental.
`int`	`getContextNumber(Environmental[] list, Environmental E)`	Returns the context number of the item in the given list is exactly the given environmental.
`int`	`getContextNumber(ItemCollection cont, Environmental E)`	Returns the context number of the item in the given collection is exactly the given environmental.
`int`	`getContextNumber(java.util.Collection<? extends Environmental> list, Environmental E)`	Returns the context number of the item in the given collection is exactly the given environmental.
`java.lang.String`	`getContextSameName(Environmental[] list, Environmental E)`	Returns the context-specific full name of the object in the given list that is otherwise identical to the given environmental.
`java.lang.String`	`getContextSameName(ItemCollection cont, Environmental E)`	Returns the context-specific full name of the object in the given collection that is otherwise identical to the given environmental.
`java.lang.String`	`getContextSameName(java.util.Collection<? extends Environmental> list, Environmental E)`	Returns the context-specific full name of the object in the given collection that is otherwise identical to the given environmental.
`int`	`getContextSameNumber(Environmental[] list, Environmental E)`	Returns the context number of the object in the given collection that is otherwise identical to the given environmental.
`int`	`getContextSameNumber(ItemCollection cont, Environmental E)`	Returns the context number of the object in the given collection that is otherwise identical to the given environmental.
`int`	`getContextSameNumber(java.util.Collection<? extends Environmental> list, Environmental E)`	Returns the context number of the object in the given list that is otherwise identical to the given environmental.
`java.lang.String`	`getFirstWord(java.lang.String str)`	Returns the first word in the given phrase, ignoring color.
`long`	`getMillisMultiplierByName(java.lang.String timeName)`	Converts the given time specifier, or something that might be a time specifier, into the appropriate number of milliseconds.
`java.lang.String`	`getSkillInvokeWord(MOB mob, java.lang.String word)`	Given a user input array, this method will find the skill that is trying to be invoked by the MAIN invocation word and, if found, return that word.
`Ability`	`getSkillToInvoke(MOB mob, java.util.List<java.lang.String> commands)`	Given a user input array, this method will find the skill that is trying to be invoked by the commands and return it.
`boolean`	`hasEnglishPunctuation(java.lang.String str)`	Returns true if the given string contains any normal punctuation characters.
`boolean`	`hasPunctuation(java.lang.String str)`	Returns true if the given string contains any extended punctuation characters.
`java.lang.String`	`ID()`	The CoffeeMud Java Class ID shared by all instances of this object.
`java.lang.String`	`insertAdjectives(java.lang.String paragraph, java.lang.String[] adjsToChoose, int pctChance)`	Inserts one of the given adjectives after an article word found in the given paragraph, a given percentage chance of the time.
`java.lang.String`	`insertUnColoredAdjective(java.lang.String str, java.lang.String adjective)`	Inserts the given adjective before a given word or noun phrase, replacing any indefinite articles with the new correct one, and removing any "color" characters from the final phrase.
`void`	`invokeSkill(MOB mob, java.util.List<java.lang.String> commands)`	Given a user input array, this method will find the skill that is trying to be invoked by the commands and invoke it.
`boolean`	`isAnArticle(java.lang.String s)`	Returns whether the given string is an article, such as a, an, the, some, etc..
`boolean`	`isAnIndefiniteArticle(java.lang.String s)`	Returns whether the given string is an indefinite article, such as a, an, some, etc..
`boolean`	`isEnglishPunctuation(byte b)`	Returns true if the given byte is any normal punctuation character.
`boolean`	`isPunctuation(byte b)`	Returns true if the given byte is any extended punctuation character.
`protected java.lang.String`	`makeLowNumberWords(short num, boolean and)`
`java.lang.String`	`makeNumberthWords(int num)`	Returns the english representation of the given numberst, numberth, number-numberth, etc.
`java.lang.String`	`makeNumberWords(double num, int precision)`	Returns the english representation of the given number
`java.lang.String`	`makePastTense(java.lang.String word, java.lang.String defaultWord)`	Returns a best guess on the past-tense form of the given word.
`java.lang.String`	`makePlural(java.lang.String str)`	Attempts to pluralize a given word.
`java.lang.String`	`makeSingular(java.lang.String str)`	Attempts to de-pluralize a given word.
`java.lang.String`	`matchAnyCurrencySet(java.lang.String moneyStr)`	For cases when a string input must contain an amount of money, this method is used to determine the currency id reflect by the whole denomination specified by the given user input.
`double`	`matchAnyDenomination(java.lang.String currency, java.lang.String moneyStr)`	For cases when a string input must contain an amount of money, this method is used to determine the Whole Denomination multiplier specified by the given user input, and optionally, from the given currency.
`Item`	`parseBestPossibleGold(MOB mob, Container container, java.lang.String itemID)`	Attempts to determine if the given user input specifies an amount of currency owned by the given player, and if so, returns that precise amount parsed from the players existing currency.
`int`	`parseMaxToGive(MOB mob, java.util.List<java.lang.String> commands, boolean breakPackages, Environmental checkWhat, boolean getOnly)`	Parses user input to determine if the user, who is specifying an item of some sort, is intending to specify multiples of those items by using a number in front of their input.
`Triad<java.lang.String,java.lang.Double,java.lang.Long>`	`parseMoneyStringSDL(MOB mob, java.lang.String moneyStr, java.lang.String correctCurrency)`	For cases when a string input probably contains an amount of money, this method is used to determine the currency, denomination, and number of units of that currency.
`long`	`parseNumPossibleGold(Environmental mine, java.lang.String moneyStr)`	For cases when a string input probably contains an amount of money, this method is used to determine the amount (not value).
`java.lang.String`	`parseNumPossibleGoldCurrency(Environmental mine, java.lang.String moneyStr)`	For cases when a string input probably contains an amount of money, this method is used to determine the currency id.
`double`	`parseNumPossibleGoldDenomination(Environmental mine, java.lang.String currency, java.lang.String moneyStr)`	For cases when a string input probably contains an amount of money, this method is used to determine the denomination.
`Item`	`parsePossibleContainer(MOB mob, java.util.List<java.lang.String> commands, boolean withStuff, Filterer<Environmental> filter)`	Attempts to determine if the given user command input is specifying a container as the last argument, for cases when that would be possible.
`java.util.List<Container>`	`parsePossibleContainers(MOB mob, java.util.List<java.lang.String> commands, Filterer<Environmental> filter, boolean withContentOnly)`	Attempts to determine if the given user command input is specifying one or more containers, for cases when that would be possible.
`Item`	`parsePossibleRoomGold(MOB seer, Room room, Container container, java.lang.String moneyStr)`	Attempts to determine if the given user input specifies an amount of currency in the given room, and if so, returns that precise amount parsed from the rooms existing currency.
`Environmental`	`parseShopkeeper(MOB mob, java.util.List<java.lang.String> matchWords, java.lang.String fromTo, java.lang.String error)`	Returns a matching shopkeeper from a given and his/her location, or null.
`java.lang.Long`	`parseSpaceDistance(java.lang.String dist)`	Returns the distance in decameters represented by the given parsable user-entered string.
`java.util.List<java.lang.String>`	`parseWords(java.lang.String thisStr)`	Strips out all punctuation and returns the individual words in an english sentence.
`boolean`	`preInvokeSkill(MOB mob, java.util.List<java.lang.String> commands, int secondsElapsed, double actionsRemaining)`	Given a user input array, this method will find the skill that is trying to be invoked by the commands, but which cannot be due to insufficient action points, and then call preinvoke on it.
`int`	`probabilityOfBeingEnglish(java.lang.String str)`	Returns the probability 0-100 of the given string being english.
`java.lang.String`	`properIndefiniteArticle(java.lang.String str)`	Returns the proper indefinite article -- a or an, for the given noun or noun-phrase.
`java.lang.String`	`removeArticleLead(java.lang.String s)`	If the given phrase begins with an article word such as a, an, some, etc..
`java.lang.String`	`sizeDescShort(long size)`	Returns [best distance] for the given number.
`protected int`	`skipSpaces(java.lang.String paragraph, int index)`
`java.lang.String`	`spaceOutPunctuation(java.lang.String str)`	Returns the given string with any punctuation changed into spaces.
`java.lang.String`	`speedDescShort(double speed)`	Rounds the given speed and returns [speed]/sec
`boolean`	`startsWithAnArticle(java.lang.String s)`	Returns whether the given word or phrase starts with an article, such as a, an, the, some, etc..
`boolean`	`startsWithAnIndefiniteArticle(java.lang.String s)`	Returns whether the given word or phrase starts with an indefinite article, such as a, an, some, etc..
`java.lang.String`	`startWithAorAn(java.lang.String str)`	Returns the proper indefinite article for the given word/phrase
`java.lang.String`	`stringifyElapsedTimeOrTicks(long millis, long ticks)`	Converts the given number of milliseconds into ms, s, m, h, d, etc...
`java.lang.String`	`stripEnglishPunctuation(java.lang.String str)`	Returns the given string with normal punctuation removed.
`java.lang.String`	`stripPunctuation(java.lang.String str)`	Returns the given string with extended punctuation removed.
`java.lang.String`	`toEnglishStringList(java.lang.Class<? extends java.lang.Enum<?>> enumer, boolean andOr)`	Returns comma-space delimited list of the given emum names.
`java.lang.String`	`toEnglishStringList(java.lang.String[] V, boolean andOr)`	Returns comma-space delimited list of the given objects.toString().
`java.lang.String`	`toEnglishStringList(java.util.Collection<? extends java.lang.Object> V)`	Returns comma-space delimited list of the given objects.toString().
`protected boolean`	`unsafeContainsString(char[] toSrchC, java.lang.String srchForStr)`

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
  - PUNCTUATION_TABLE
```
public static boolean[] PUNCTUATION_TABLE
```
  - NARROW_PUNCTUATION_TABLE
```
public static boolean[] NARROW_PUNCTUATION_TABLE
```
  - ARTICLES
```
public static final java.lang.String[] ARTICLES
```
  - INDARTICLES
```
public static final java.lang.String[] INDARTICLES
```
  - ALL_CHRS
```
public static final char[] ALL_CHRS
```
  - fwords
```
public static final java.lang.String[] fwords
```
  - frwords
```
public static final java.lang.String[] frwords
```
  - fnouns
```
public static final java.lang.String[] fnouns
```
  - feewords1
```
public static final java.lang.String[] feewords1
```
  - feewords2
```
public static final java.lang.String[] feewords2
```
  - num_words
```
public static final java.lang.String[] num_words
```
  - num_words_10
```
public static final java.lang.String[] num_words_10
```
  - num_words_x
```
public static final java.lang.String[] num_words_x
```
  - numth_words
```
public static final java.lang.String[] numth_words
```
  - empty
```
public static final java.util.List<Environmental> empty
```
- Constructor Detail
  - EnglishParser
```
public EnglishParser()
```
- 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
  - toEnglishStringList
```
public java.lang.String toEnglishStringList(java.lang.String[] V,
                                            boolean andOr)
```
    Description copied from interface: EnglishParsing
    
    Returns comma-space delimited list of the given objects.toString(). The final entry will have an "and" prepended. Oxford commas are used.
    
    Specified by:
    
    toEnglishStringList in interface EnglishParsing
    
    Parameters:
    
    V - the collection of things to treat as strings
    
    andOr - true to connect with AND, false for OR
    
    Returns:
    
    the comma-space delimited list
  - toEnglishStringList
```
public java.lang.String toEnglishStringList(java.lang.Class<? extends java.lang.Enum<?>> enumer,
                                            boolean andOr)
```
    Description copied from interface: EnglishParsing
    
    Returns comma-space delimited list of the given emum names. The final entry will have an "and" or "or" prepended. Oxford commas are used.
    
    Specified by:
    
    toEnglishStringList in interface EnglishParsing
    
    Parameters:
    
    enumer - the collection of things to treat as strings
    
    andOr - true to use AND, false to use OR
    
    Returns:
    
    the comma-space delimited list
  - toEnglishStringList
```
public java.lang.String toEnglishStringList(java.util.Collection<? extends java.lang.Object> V)
```
    Description copied from interface: EnglishParsing
    
    Returns comma-space delimited list of the given objects.toString(). The final entry will have an "and" prepended. Oxford commas are used.
    
    Specified by:
    
    toEnglishStringList in interface EnglishParsing
    
    Parameters:
    
    V - the collection of things to treat as strings
    
    Returns:
    
    the comma-space delimited list
  - makeLowNumberWords
```
protected java.lang.String makeLowNumberWords(short num,
                                              boolean and)
```
  - makeNumberthWords
```
public java.lang.String makeNumberthWords(int num)
```
    Description copied from interface: EnglishParsing
    
    Returns the english representation of the given numberst, numberth, number-numberth, etc.
    
    Specified by:
    
    makeNumberthWords in interface EnglishParsing
    
    Parameters:
    
    num - the num to translate
    
    Returns:
    
    the th words
  - makeNumberWords
```
public java.lang.String makeNumberWords(double num,
                                        int precision)
```
    Description copied from interface: EnglishParsing
    
    Returns the english representation of the given number
    
    Specified by:
    
    makeNumberWords in interface EnglishParsing
    
    Parameters:
    
    num - the number
    
    precision - the number of digits less than 0
    
    Returns:
    
    the number in english
  - makePastTense
```
public java.lang.String makePastTense(java.lang.String word,
                                      java.lang.String defaultWord)
```
    Description copied from interface: EnglishParsing
    
    Returns a best guess on the past-tense form of the given word. If the word is null or empty, then the default word is returned.
    
    Specified by:
    
    makePastTense in interface EnglishParsing
    
    Parameters:
    
    word - the word to past-tensize
    
    defaultWord - the word to use if none given
    
    Returns:
    
    the paten-tensed word.
  - isAnArticle
```
public boolean isAnArticle(java.lang.String s)
```
    Description copied from interface: EnglishParsing
    
    Returns whether the given string is an article, such as a, an, the, some, etc.. Colors are not respected.
    
    Specified by:
    
    isAnArticle in interface EnglishParsing
    
    Parameters:
    
    s - the string to check
    
    Returns:
    
    true if its an article, false otherwise
    
    See Also:
    
    EnglishParsing.isAnIndefiniteArticle(String), EnglishParsing.startsWithAnArticle(String), EnglishParsing.startsWithAnIndefiniteArticle(String)
  - isAnIndefiniteArticle
```
public boolean isAnIndefiniteArticle(java.lang.String s)
```
    Description copied from interface: EnglishParsing
    
    Returns whether the given string is an indefinite article, such as a, an, some, etc.. Colors are not respected.
    
    Specified by:
    
    isAnIndefiniteArticle in interface EnglishParsing
    
    Parameters:
    
    s - the string to check
    
    Returns:
    
    true if its an indefinite article, false otherwise
    
    See Also:
    
    EnglishParsing.isAnArticle(String), EnglishParsing.startsWithAnArticle(String), EnglishParsing.startsWithAnIndefiniteArticle(String)
  - makePlural
```
public java.lang.String makePlural(java.lang.String str)
```
    Description copied from interface: EnglishParsing
    
    Attempts to pluralize a given word. It's just a best guess. Must not be colored.
    
    Specified by:
    
    makePlural in interface EnglishParsing
    
    Parameters:
    
    str - the word to pluralize
    
    Returns:
    
    the word, pluralized, hopefuly
  - makeSingular
```
public java.lang.String makeSingular(java.lang.String str)
```
    Description copied from interface: EnglishParsing
    
    Attempts to de-pluralize a given word. It's just a best guess. Must not be colored.
    
    Specified by:
    
    makeSingular in interface EnglishParsing
    
    Parameters:
    
    str - the word to de-pluralize
    
    Returns:
    
    the word, de-pluralized, hopefuly
  - cleanPrepositions
```
public java.lang.String cleanPrepositions(java.lang.String s)
```
    Description copied from interface: EnglishParsing
    
    If the given phrase begins with a preposition word such as to, over, beside, than, since, it will strip the word off and return the rest of the string. Colors are not respected.
    
    Specified by:
    
    cleanPrepositions in interface EnglishParsing
    
    Parameters:
    
    s - the string to clean
    
    Returns:
    
    the string, or the string cleaned
  - properIndefiniteArticle
```
public java.lang.String properIndefiniteArticle(java.lang.String str)
```
    Description copied from interface: EnglishParsing
    
    Returns the proper indefinite article -- a or an, for the given noun or noun-phrase. Ignores colors.
    
    Specified by:
    
    properIndefiniteArticle in interface EnglishParsing
    
    Parameters:
    
    str - the noun or noun phrase
    
    Returns:
    
    either 'a' or 'an'
  - getBestDistance
```
protected java.lang.String getBestDistance(long d)
```
  - sizeDescShort
```
public java.lang.String sizeDescShort(long size)
```
    Description copied from interface: EnglishParsing
    
    Returns [best distance] for the given number. A [best distance] picks the best of dm, km, etc..
    
    Specified by:
    
    sizeDescShort in interface EnglishParsing
    
    Parameters:
    
    size - the full dm distance
    
    Returns:
    
    the best size string
    
    See Also:
    
    EnglishParsing.distanceDescShort(long)
  - distanceDescShort
```
public java.lang.String distanceDescShort(long distance)
```
    Description copied from interface: EnglishParsing
    
    Returns [best distance] for the given number. A [best distance] picks the best of dm, km, etc..
    
    Specified by:
    
    distanceDescShort in interface EnglishParsing
    
    Parameters:
    
    distance - the full dm distance
    
    Returns:
    
    the best distance string
    
    See Also:
    
    EnglishParsing.sizeDescShort(long)
  - coordDescShort
```
public java.lang.String coordDescShort(long[] coords)
```
    Description copied from interface: EnglishParsing
    
    Returns [best distance],[best distance],[best distance] A [best distance] picks the best of dm, km, etc..
    
    Specified by:
    
    coordDescShort in interface EnglishParsing
    
    Parameters:
    
    coords - the 3-absolute coords
    
    Returns:
    
    a displayable best distance coordinate
    
    See Also:
    
    EnglishParsing.sizeDescShort(long)
  - speedDescShort
```
public java.lang.String speedDescShort(double speed)
```
    Description copied from interface: EnglishParsing
    
    Rounds the given speed and returns [speed]/sec
    
    Specified by:
    
    speedDescShort in interface EnglishParsing
    
    Parameters:
    
    speed - the raw speed double
    
    Returns:
    
    a friendlier display speed per sec
  - directionDescShort
```
public java.lang.String directionDescShort(double[] dir)
```
    Description copied from interface: EnglishParsing
    
    Returns direction in [degrees.YY] mark [degrees.YY]
    
    Specified by:
    
    directionDescShort in interface EnglishParsing
    
    Parameters:
    
    dir - the direction in radians
    
    Returns:
    
    a short direction string
    
    See Also:
    
    EnglishParsing.directionDescShortest(double[])
  - directionDescShortest
```
public java.lang.String directionDescShortest(double[] dir)
```
    Description copied from interface: EnglishParsing
    
    Returns direction in [degrees.Y] [space] [degrees.Y]
    
    Specified by:
    
    directionDescShortest in interface EnglishParsing
    
    Parameters:
    
    dir - the direction in radians
    
    Returns:
    
    a shortest direction possible
    
    See Also:
    
    EnglishParsing.directionDescShort(double[])
  - parseSpaceDistance
```
public java.lang.Long parseSpaceDistance(java.lang.String dist)
```
    Description copied from interface: EnglishParsing
    
    Returns the distance in decameters represented by the given parsable user-entered string.
    
    Specified by:
    
    parseSpaceDistance in interface EnglishParsing
    
    Parameters:
    
    dist - the user-entered string
    
    Returns:
    
    the distance in decameters
  - getFirstWord
```
public java.lang.String getFirstWord(java.lang.String str)
```
    Description copied from interface: EnglishParsing
    
    Returns the first word in the given phrase, ignoring color. It must start with a letter.
    
    Specified by:
    
    getFirstWord in interface EnglishParsing
    
    Parameters:
    
    str - the phrase to look in
    
    Returns:
    
    the first word
  - startWithAorAn
```
public java.lang.String startWithAorAn(java.lang.String str)
```
    Description copied from interface: EnglishParsing
    
    Returns the proper indefinite article for the given word/phrase
    
    Specified by:
    
    startWithAorAn in interface EnglishParsing
    
    Parameters:
    
    str - the word/phrase that needs an indefinite article
    
    Returns:
    
    the word/phrase with the article prepended
  - startsWithAnArticle
```
public boolean startsWithAnArticle(java.lang.String s)
```
    Description copied from interface: EnglishParsing
    
    Returns whether the given word or phrase starts with an article, such as a, an, the, some, etc.. Colors codes are totally respected.
    
    Specified by:
    
    startsWithAnArticle in interface EnglishParsing
    
    Parameters:
    
    s - the string to check
    
    Returns:
    
    true if the string starts with an article
    
    See Also:
    
    EnglishParsing.isAnArticle(String), EnglishParsing.isAnIndefiniteArticle(String), EnglishParsing.startsWithAnIndefiniteArticle(String)
  - startsWithAnIndefiniteArticle
```
public boolean startsWithAnIndefiniteArticle(java.lang.String s)
```
    Description copied from interface: EnglishParsing
    
    Returns whether the given word or phrase starts with an indefinite article, such as a, an, some, etc.. Colors codes are totally respected.
    
    Specified by:
    
    startsWithAnIndefiniteArticle in interface EnglishParsing
    
    Parameters:
    
    s - the string to check
    
    Returns:
    
    true if the string starts with an indefinite article
    
    See Also:
    
    EnglishParsing.isAnArticle(String), EnglishParsing.isAnIndefiniteArticle(String), EnglishParsing.startsWithAnArticle(String)
  - removeArticleLead
```
public java.lang.String removeArticleLead(java.lang.String s)
```
    Description copied from interface: EnglishParsing
    
    If the given phrase begins with an article word such as a, an, some, etc.. it will strip the word off and return the rest of the string. Colors codes are totally respected!
    
    Specified by:
    
    removeArticleLead in interface EnglishParsing
    
    Parameters:
    
    s - the string to clean
    
    Returns:
    
    the string, or the string cleaned
  - insertUnColoredAdjective
```
public java.lang.String insertUnColoredAdjective(java.lang.String str,
                                                 java.lang.String adjective)
```
    Description copied from interface: EnglishParsing
    
    Inserts the given adjective before a given word or noun phrase, replacing any indefinite articles with the new correct one, and removing any "color" characters from the final phrase.
    
    Specified by:
    
    insertUnColoredAdjective in interface EnglishParsing
    
    Parameters:
    
    str - the word or noun phrase
    
    adjective - the adjective to add
    
    Returns:
    
    the adjectivy word or noun phrase
  - skipSpaces
```
protected int skipSpaces(java.lang.String paragraph,
                         int index)
```
  - insertAdjectives
```
public java.lang.String insertAdjectives(java.lang.String paragraph,
                                         java.lang.String[] adjsToChoose,
                                         int pctChance)
```
    Description copied from interface: EnglishParsing
    
    Inserts one of the given adjectives after an article word found in the given paragraph, a given percentage chance of the time.
    
    Specified by:
    
    insertAdjectives in interface EnglishParsing
    
    Parameters:
    
    paragraph - The paragraph with nouns after articles
    
    adjsToChoose - the list of adjectives to choose from
    
    pctChance - the pct chance that any particular noun gets an adjective
    
    Returns:
    
    the modified paragraph
  - findSocial
```
public Social findSocial(MOB mob,
                         java.util.List<java.lang.String> commands,
                         boolean exactOnly)
```
  - findCommand
```
public CMObject findCommand(MOB mob,
                            java.util.List<java.lang.String> commands)
```
    Description copied from interface: EnglishParsing
    
    Given a user input array, this method will find the skill, command, social, channel, or journal that is trying to be invoked by the user input and, if found, return it. Will silently return null otherwise.
    
    Specified by:
    
    findCommand in interface EnglishParsing
    
    Parameters:
    
    mob - the player/mob trying to invoke a command
    
    commands - the user input array of the invocation
    
    Returns:
    
    the Ability, Command, Social, etc, or null if not found.
  - evokedBy
```
protected boolean evokedBy(Ability thisAbility,
                           java.lang.String thisWord)
```
  - collapsedName
```
protected java.lang.String collapsedName(Ability thisAbility)
```
  - evokedBy
```
protected boolean evokedBy(Ability thisAbility,
                           java.lang.String thisWord,
                           java.lang.String secondWord)
```
  - getSkillInvokeWord
```
public java.lang.String getSkillInvokeWord(MOB mob,
                                           java.lang.String word)
```
    Description copied from interface: EnglishParsing
    
    Given a user input array, this method will find the skill that is trying to be invoked by the MAIN invocation word and, if found, return that word.
    
    Specified by:
    
    getSkillInvokeWord in interface EnglishParsing
    
    Parameters:
    
    mob - the player/mob trying to invoke a skill
    
    word - the user input of the invocation
    
    Returns:
    
    the invocation word found
  - getSkillToInvoke
```
public Ability getSkillToInvoke(MOB mob,
                                java.util.List<java.lang.String> commands)
```
    Description copied from interface: EnglishParsing
    
    Given a user input array, this method will find the skill that is trying to be invoked by the commands and return it. It will intelligently pick between multiple skills with the same invocation words (CAST, PRAY, etc) by using the skill names. DOES modify the invoke commands to remove the invocation word(s)
    
    Specified by:
    
    getSkillToInvoke in interface EnglishParsing
    
    Parameters:
    
    mob - the player/mob trying to invoke a skill
    
    commands - the user input array of the invocation
    
    Returns:
    
    the Ability found, or null if none
  - preInvokeSkill
```
public boolean preInvokeSkill(MOB mob,
                              java.util.List<java.lang.String> commands,
                              int secondsElapsed,
                              double actionsRemaining)
```
    Description copied from interface: EnglishParsing
    
    Given a user input array, this method will find the skill that is trying to be invoked by the commands, but which cannot be due to insufficient action points, and then call preinvoke on it. If the skill isn't found, the user is notified of the failure and false is returned. This may be called repeatedly until the skill can actually be invoked properly. DOES modify the invoke commands to remove the invocation word(s)
    
    Specified by:
    
    preInvokeSkill in interface EnglishParsing
    
    Parameters:
    
    mob - the player mob trying to use a skill
    
    commands - the skill command words and arguments
    
    secondsElapsed - the seconds ellapsed since initial attempt
    
    actionsRemaining - the additional action points required
    
    Returns:
    
    true to continue pre invoking, and false to cancel
  - invokeSkill
```
public void invokeSkill(MOB mob,
                        java.util.List<java.lang.String> commands)
```
    Description copied from interface: EnglishParsing
    
    Given a user input array, this method will find the skill that is trying to be invoked by the commands and invoke it. If the skill isn't found, the user is notified of the failure. DOES modify the invoke commands to remove the invocation word(s)
    
    Specified by:
    
    invokeSkill in interface EnglishParsing
    
    Parameters:
    
    mob - the player/mob trying to invoke a skill
    
    commands - the user input array of the invocation
  - isPunctuation
```
public boolean isPunctuation(byte b)
```
    Description copied from interface: EnglishParsing
    
    Returns true if the given byte is any extended punctuation character. Such as +-,;:.?! etc.. Must not be colored.
    
    Specified by:
    
    isPunctuation in interface EnglishParsing
    
    Parameters:
    
    b - the byte to check
    
    Returns:
    
    true if punctuation, false otherwise
  - isEnglishPunctuation
```
public boolean isEnglishPunctuation(byte b)
```
    Description copied from interface: EnglishParsing
    
    Returns true if the given byte is any normal punctuation character. Such as ,;:.?! etc.. Must not be colored.
    
    Specified by:
    
    isEnglishPunctuation in interface EnglishParsing
    
    Parameters:
    
    b - the byte to check
    
    Returns:
    
    true if punctuation, false otherwise
  - hasEnglishPunctuation
```
public boolean hasEnglishPunctuation(java.lang.String str)
```
    Description copied from interface: EnglishParsing
    
    Returns true if the given string contains any normal punctuation characters. Such as ,;:.?! etc.. Must not be colored.
    
    Specified by:
    
    hasEnglishPunctuation in interface EnglishParsing
    
    Parameters:
    
    str - the string to check
    
    Returns:
    
    true if punctuation found, false otherwise
  - stripEnglishPunctuation
```
public java.lang.String stripEnglishPunctuation(java.lang.String str)
```
    Description copied from interface: EnglishParsing
    
    Returns the given string with normal punctuation removed. Must not be colored.
    
    Specified by:
    
    stripEnglishPunctuation in interface EnglishParsing
    
    Parameters:
    
    str - the string to check
    
    Returns:
    
    the string, with punctuation removed
  - hasPunctuation
```
public boolean hasPunctuation(java.lang.String str)
```
    Description copied from interface: EnglishParsing
    
    Returns true if the given string contains any extended punctuation characters. Such as +-,;:.?! etc.. Must not be colored.
    
    Specified by:
    
    hasPunctuation in interface EnglishParsing
    
    Parameters:
    
    str - the string to check
    
    Returns:
    
    true if punctuation found, false otherwise
  - stripPunctuation
```
public java.lang.String stripPunctuation(java.lang.String str)
```
    Description copied from interface: EnglishParsing
    
    Returns the given string with extended punctuation removed. Must not be colored.
    
    Specified by:
    
    stripPunctuation in interface EnglishParsing
    
    Parameters:
    
    str - the string to check
    
    Returns:
    
    the string, with punctuation removed
  - spaceOutPunctuation
```
public java.lang.String spaceOutPunctuation(java.lang.String str)
```
    Description copied from interface: EnglishParsing
    
    Returns the given string with any punctuation changed into spaces. Don't know why. Must not be colored.
    
    Specified by:
    
    spaceOutPunctuation in interface EnglishParsing
    
    Parameters:
    
    str - the string to convert
    
    Returns:
    
    the string without spaces
  - parseWords
```
public java.util.List<java.lang.String> parseWords(java.lang.String thisStr)
```
    Description copied from interface: EnglishParsing
    
    Strips out all punctuation and returns the individual words in an english sentence.
    
    Specified by:
    
    parseWords in interface EnglishParsing
    
    Parameters:
    
    thisStr - the sentence
    
    Returns:
    
    the individual words
  - equalsPunctuationless
```
public boolean equalsPunctuationless(char[] strC,
                                     char[] str2C)
```
  - containsOneOfString
```
public boolean containsOneOfString(java.lang.String toSrchStr,
                                   java.util.List<java.lang.String> srchForStrs)
```
    Description copied from interface: EnglishParsing
    
    Returns whether the given string contains any of the srchForStr substrings. The searches are case insensitive, and color * insensitive, and respects special syntax like '$' to ensure complete hits.
    
    Specified by:
    
    containsOneOfString in interface EnglishParsing
    
    Parameters:
    
    toSrchStr - the string to search inside of
    
    srchForStrs - the strings to search for
    
    Returns:
    
    true if any matches are found.
  - containsString
```
public boolean containsString(java.lang.String toSrchStr,
                              java.lang.String srchForStr)
```
    Description copied from interface: EnglishParsing
    
    Returns whether the first string contains the second, case insensitive, and color insensitive. Respects special syntax like '$' to ensure complete hits.
    
    Specified by:
    
    containsString in interface EnglishParsing
    
    Parameters:
    
    toSrchStr - the string to search through
    
    srchForStr - the string to search for in the first string
    
    Returns:
    
    true if the second string appears in the first, false otherwise
  - unsafeContainsString
```
protected final boolean unsafeContainsString(char[] toSrchC,
                                             java.lang.String srchForStr)
```
  - bumpDotContextNumber
```
public java.lang.String bumpDotContextNumber(java.lang.String srchStr,
                                             int thisMuch)
```
    Description copied from interface: EnglishParsing
    
    Given a context-specific name, this method returns the name with the number adjusted according to the given amount. There is NO validation that the resulting context number remains valid.
    
    Specified by:
    
    bumpDotContextNumber in interface EnglishParsing
    
    Parameters:
    
    srchStr - the context name
    
    thisMuch - the amount to adjust by, + or -
    
    Returns:
    
    the new name
  - getContextDotNumber
```
public int getContextDotNumber(java.lang.String srchStr)
```
    Description copied from interface: EnglishParsing
    
    Returns the context number of the given context-specific name.
    
    Specified by:
    
    getContextDotNumber in interface EnglishParsing
    
    Parameters:
    
    srchStr - the context-specific name
    
    Returns:
    
    the number found, or 0
  - getContextNumber
```
public int getContextNumber(ItemCollection cont,
                            Environmental E)
```
    Description copied from interface: EnglishParsing
    
    Returns the context number of the item in the given collection is exactly the given environmental.
    
    Specified by:
    
    getContextNumber in interface EnglishParsing
    
    Parameters:
    
    cont - the collection containing the environmental
    
    E - the object to find in the collection
    
    Returns:
    
    the context number, or -1
  - getContextNumber
```
public int getContextNumber(Environmental[] list,
                            Environmental E)
```
    Description copied from interface: EnglishParsing
    
    Returns the context number of the item in the given list is exactly the given environmental.
    
    Specified by:
    
    getContextNumber in interface EnglishParsing
    
    Parameters:
    
    list - the list containing the environmental
    
    E - the object to find in the list
    
    Returns:
    
    the context number, or -1
  - getContextNumber
```
public int getContextNumber(java.util.Collection<? extends Environmental> list,
                            Environmental E)
```
    Description copied from interface: EnglishParsing
    
    Returns the context number of the item in the given collection is exactly the given environmental.
    
    Specified by:
    
    getContextNumber in interface EnglishParsing
    
    Parameters:
    
    list - the collection containing the environmental
    
    E - the object to find in the collection
    
    Returns:
    
    the context number, or -1
  - getContextSameNumber
```
public int getContextSameNumber(ItemCollection cont,
                                Environmental E)
```
    Description copied from interface: EnglishParsing
    
    Returns the context number of the object in the given collection that is otherwise identical to the given environmental.
    
    Specified by:
    
    getContextSameNumber in interface EnglishParsing
    
    Parameters:
    
    cont - the collection to find a match in
    
    E - the environmental to find in the collection
    
    Returns:
    
    the context number of the item in the collection, or -1
  - getContextSameNumber
```
public int getContextSameNumber(Environmental[] list,
                                Environmental E)
```
    Description copied from interface: EnglishParsing
    
    Returns the context number of the object in the given collection that is otherwise identical to the given environmental.
    
    Specified by:
    
    getContextSameNumber in interface EnglishParsing
    
    Parameters:
    
    list - the collection to find a match in
    
    E - the environmental to find in the collection
    
    Returns:
    
    the context number of the item in the collection, or -1
  - getContextSameNumber
```
public int getContextSameNumber(java.util.Collection<? extends Environmental> list,
                                Environmental E)
```
    Description copied from interface: EnglishParsing
    
    Returns the context number of the object in the given list that is otherwise identical to the given environmental.
    
    Specified by:
    
    getContextSameNumber in interface EnglishParsing
    
    Parameters:
    
    list - the list to find a match in
    
    E - the environmental to find in the collection
    
    Returns:
    
    the context number of the item in the list, or -1
  - getContextName
```
public java.lang.String getContextName(ItemCollection cont,
                                       Environmental E)
```
    Description copied from interface: EnglishParsing
    
    Returns the context-qualified name of the item in the given collection is exactly the given environmental.
    
    Specified by:
    
    getContextName in interface EnglishParsing
    
    Parameters:
    
    cont - the collection containing the environmental
    
    E - the object to find in the collection
    
    Returns:
    
    the context-qualified name
  - getContextName
```
public java.lang.String getContextName(Environmental[] list,
                                       Environmental E)
```
    Description copied from interface: EnglishParsing
    
    Returns the context-qualified name of the item in the given list is exactly the given environmental.
    
    Specified by:
    
    getContextName in interface EnglishParsing
    
    Parameters:
    
    list - the list containing the environmental
    
    E - the object to find in the list
    
    Returns:
    
    the context-qualified name
  - getContextName
```
public java.lang.String getContextName(java.util.Collection<? extends Environmental> list,
                                       Environmental E)
```
    Description copied from interface: EnglishParsing
    
    Returns the context-qualified name of the item in the given collection is exactly the given environmental.
    
    Specified by:
    
    getContextName in interface EnglishParsing
    
    Parameters:
    
    list - the collection containing the environmental
    
    E - the object to find in the collection
    
    Returns:
    
    the context-qualified name
  - getAllContextNames
```
public java.util.List<java.lang.String> getAllContextNames(java.util.Collection<? extends Environmental> list,
                                                           Filterer<Environmental> filter)
```
    Description copied from interface: EnglishParsing
    
    Given a list of objects and an optional filter, this method returns a list of identical size and order, with the context-specific names instead of the objects. Items that do not match the filter are represented as "" in the returned list. It apllows easy mapping between a list and the context names.
    
    Specified by:
    
    getAllContextNames in interface EnglishParsing
    
    Parameters:
    
    list - the list of objects to return the names of
    
    filter - an optional filter, or null
    
    Returns:
    
    the list of context-specific names
  - getContextSameName
```
public java.lang.String getContextSameName(ItemCollection cont,
                                           Environmental E)
```
    Description copied from interface: EnglishParsing
    
    Returns the context-specific full name of the object in the given collection that is otherwise identical to the given environmental.
    
    Specified by:
    
    getContextSameName in interface EnglishParsing
    
    Parameters:
    
    cont - the collection to find a match in
    
    E - the environmental to find in the collection
    
    Returns:
    
    the context-specific name of the item in the collection, or null
  - getContextSameName
```
public java.lang.String getContextSameName(Environmental[] list,
                                           Environmental E)
```
    Description copied from interface: EnglishParsing
    
    Returns the context-specific full name of the object in the given list that is otherwise identical to the given environmental.
    
    Specified by:
    
    getContextSameName in interface EnglishParsing
    
    Parameters:
    
    list - the collection to find a match in
    
    E - the environmental to find in the collection
    
    Returns:
    
    the context-specific name of the item in the list, or null
  - getContextSameName
```
public java.lang.String getContextSameName(java.util.Collection<? extends Environmental> list,
                                           Environmental E)
```
    Description copied from interface: EnglishParsing
    
    Returns the context-specific full name of the object in the given collection that is otherwise identical to the given environmental.
    
    Specified by:
    
    getContextSameName in interface EnglishParsing
    
    Parameters:
    
    list - the collection to find a match in
    
    E - the environmental to find in the collection
    
    Returns:
    
    the context-specific name of the item in the collection, or null
  - parseShopkeeper
```
public Environmental parseShopkeeper(MOB mob,
                                     java.util.List<java.lang.String> matchWords,
                                     java.lang.String fromTo,
                                     java.lang.String error)
```
    Description copied from interface: EnglishParsing
    
    Returns a matching shopkeeper from a given and his/her location, or null. The shopkeeper must match the minimal *end* of the string descriptor given in matchWords, and, if found, the method will remove those terms from the matchWords list. The first word in matchWords is ALWAYS REMOVED, and so should always be a dummy term. The name matches may include object ids, names, or display text. Exact matches can be demanded using the anchor $ character on the front, back, or both, of the match words. The returned shopkeeper may not itself implement the shopkeeper interface, but will, if not implement it, have an effect that does implement it.
    
    Specified by:
    
    parseShopkeeper in interface EnglishParsing
    
    Parameters:
    
    mob - the mob looking for a shopkeeper nearby
    
    matchWords - the search words, possibly modified
    
    fromTo - whether from or to is the proper separator
    
    error - the error message to send for bad arguments
    
    Returns:
    
    a matched shopkeeper, with a modified matchWords list
  - fetchItemList
```
public java.util.List<Item> fetchItemList(ItemPossessor from,
                                          MOB mob,
                                          Item container,
                                          java.util.List<java.lang.String> matchWords,
                                          Filterer<Environmental> filter,
                                          boolean visionMatters)
```
    Description copied from interface: EnglishParsing
    
    Returns a set of matching items from a given item possessor. The items must match a string descriptor given in matchWords, as well as the given Filterer, and within the given container. The matchWords may include things like counters 1.itemname, etc, or even all itemname. The name matches may include item ids, names, or display text. Exact matches can be demanded using the anchor $ character on the front, back, or both, of the match words. The mob argument is required due to having a viewer for the visionMatters argument, and as an alternate possible source of items when the item possessor (from) is a room.
    
    Specified by:
    
    fetchItemList in interface EnglishParsing
    
    Parameters:
    
    from - The room or mob that possess items to select.
    
    mob - the mob in the room, or the viewer of the items
    
    container - the required container that the items should be in, or null
    
    matchWords - the words that must be matched to select an item
    
    filter - the required filter for items
    
    visionMatters - true if the items must be seen by the mob, or false otherwise
    
    Returns:
    
    the list of all selected items, which could be empty.
  - parseNumPossibleGold
```
public long parseNumPossibleGold(Environmental mine,
                                 java.lang.String moneyStr)
```
    Description copied from interface: EnglishParsing
    
    For cases when a string input probably contains an amount of money, this method is used to determine the amount (not value). It will attempt to prefer whatever kind of money the given mine mob has on hand, if mine is specified at all, which matches the amount in the user input. Otherwise, it will rely entirely on whatever clues the user input provides as to the amount.
    
    Specified by:
    
    parseNumPossibleGold in interface EnglishParsing
    
    Parameters:
    
    mine - someone with money, like a mob, or null
    
    moneyStr - a user input string to parse
    
    Returns:
    
    the amount of money units
  - parseNumPossibleGoldCurrency
```
public java.lang.String parseNumPossibleGoldCurrency(Environmental mine,
                                                     java.lang.String moneyStr)
```
    Description copied from interface: EnglishParsing
    
    For cases when a string input probably contains an amount of money, this method is used to determine the currency id. It will attempt to prefer whatever kind of currency the given mine mob has on hand, if mine is specified at all, which matches the amount in the user input. Otherwise, it will rely entirely on whatever clues the user input provides.
    
    Specified by:
    
    parseNumPossibleGoldCurrency in interface EnglishParsing
    
    Parameters:
    
    mine - someone with money, like a mob, or null
    
    moneyStr - a user input string to parse
    
    Returns:
    
    the currency id to use
  - getMillisMultiplierByName
```
public long getMillisMultiplierByName(java.lang.String timeName)
```
    Description copied from interface: EnglishParsing
    
    Converts the given time specifier, or something that might be a time specifier, into the appropriate number of milliseconds. The given time must be a single word. These are things like: ticks, seconds, minutes, etc, etc
    
    Specified by:
    
    getMillisMultiplierByName in interface EnglishParsing
    
    Parameters:
    
    timeName - an amount of time word
    
    Returns:
    
    the number of milliseconds, or -1
  - parseNumPossibleGoldDenomination
```
public double parseNumPossibleGoldDenomination(Environmental mine,
                                               java.lang.String currency,
                                               java.lang.String moneyStr)
```
    Description copied from interface: EnglishParsing
    
    For cases when a string input probably contains an amount of money, this method is used to determine the denomination. It will attempt to prefer whatever kind of currency the given mine mob has on hand, if mine is specified at all. Otherwise, it relies utterly on the given currency.
    
    Specified by:
    
    parseNumPossibleGoldDenomination in interface EnglishParsing
    
    Parameters:
    
    mine - someone with money, like a mob, or null
    
    currency - currency to use if mine is unavail
    
    moneyStr - a user input string to parse
    
    Returns:
    
    the denomination reflected by the input, or 0.0
  - matchAnyCurrencySet
```
public java.lang.String matchAnyCurrencySet(java.lang.String moneyStr)
```
    Description copied from interface: EnglishParsing
    
    For cases when a string input must contain an amount of money, this method is used to determine the currency id reflect by the whole denomination specified by the given user input.
    
    Specified by:
    
    matchAnyCurrencySet in interface EnglishParsing
    
    Parameters:
    
    moneyStr - the user input that contains a denomination
    
    Returns:
    
    the currency id reflecting the found denomination, or null
  - matchAnyDenomination
```
public double matchAnyDenomination(java.lang.String currency,
                                   java.lang.String moneyStr)
```
    Description copied from interface: EnglishParsing
    
    For cases when a string input must contain an amount of money, this method is used to determine the Whole Denomination multiplier specified by the given user input, and optionally, from the given currency.
    
    Specified by:
    
    matchAnyDenomination in interface EnglishParsing
    
    Parameters:
    
    currency - currency id, or null will check all currencies, but why?
    
    moneyStr - the user input that contains a denomination
    
    Returns:
    
    the whole denomination found, or 0.0 for no match
  - parsePossibleRoomGold
```
public Item parsePossibleRoomGold(MOB seer,
                                  Room room,
                                  Container container,
                                  java.lang.String moneyStr)
```
    Description copied from interface: EnglishParsing
    
    Attempts to determine if the given user input specifies an amount of currency in the given room, and if so, returns that precise amount parsed from the rooms existing currency. If the input string does not seem to specify money, then null is quietly returned.
    
    Specified by:
    
    parsePossibleRoomGold in interface EnglishParsing
    
    Parameters:
    
    seer - the player looking to get some money
    
    room - the room the money is in
    
    container - the container the money is in, or null
    
    moneyStr - the user input
    
    Returns:
    
    null, or the exact currency object to get
  - parseBestPossibleGold
```
public Item parseBestPossibleGold(MOB mob,
                                  Container container,
                                  java.lang.String itemID)
```
    Description copied from interface: EnglishParsing
    
    Attempts to determine if the given user input specifies an amount of currency owned by the given player, and if so, returns that precise amount parsed from the players existing currency. If the input string does not seem to specify money, then null is quietly returned. if it does specify money, but more than the player has, then the player will receive an error, and null is still returned.
    
    Specified by:
    
    parseBestPossibleGold in interface EnglishParsing
    
    Parameters:
    
    mob - the player looking to give away their money
    
    container - the container it must be in, or null
    
    itemID - the user input
    
    Returns:
    
    the players currency as an object, or null
  - parsePossibleContainers
```
public java.util.List<Container> parsePossibleContainers(MOB mob,
                                                         java.util.List<java.lang.String> commands,
                                                         Filterer<Environmental> filter,
                                                         boolean withContentOnly)
```
    Description copied from interface: EnglishParsing
    
    Attempts to determine if the given user command input is specifying one or more containers, for cases when that would be possible. It does this by looking for words like "from", "in", or "on", or the last word, and then checking whether it specifies a container. If containers is found, the given input array is modified. The containers may be in the players inv, or in the room. The word 'all' is parsed out for multiple containers.
    
    Specified by:
    
    parsePossibleContainers in interface EnglishParsing
    
    Parameters:
    
    mob - the player whose commands are parsed
    
    commands - the commands to parse and check
    
    filter - filter for allowed containers, or null
    
    withContentOnly - true if the container must not be empty
    
    Returns:
    
    list of all containers found, which may be empty
  - parsePossibleContainer
```
public Item parsePossibleContainer(MOB mob,
                                   java.util.List<java.lang.String> commands,
                                   boolean withStuff,
                                   Filterer<Environmental> filter)
```
    Description copied from interface: EnglishParsing
    
    Attempts to determine if the given user command input is specifying a container as the last argument, for cases when that would be possible. It does this by looking for words like "from", "in", or "on", or the last word, and then checking whether it specifies a container. If a container is found, the given input array is modified. The container may be in the players inv, or in the room.
    
    Specified by:
    
    parsePossibleContainer in interface EnglishParsing
    
    Parameters:
    
    mob - the player whose commands are parsed
    
    commands - the commands to parse and check
    
    withStuff - true if the container must not be empty
    
    filter - filter for allowed containers, or null
    
    Returns:
    
    the container found, or null
  - stringifyElapsedTimeOrTicks
```
public java.lang.String stringifyElapsedTimeOrTicks(long millis,
                                                    long ticks)
```
    Description copied from interface: EnglishParsing
    
    Converts the given number of milliseconds into ms, s, m, h, d, etc... If a number of ticks > 0 is also given, it will append them as an average ms/tick.
    
    Specified by:
    
    stringifyElapsedTimeOrTicks in interface EnglishParsing
    
    Parameters:
    
    millis - the number of ellapsed milliseconds to convert
    
    ticks - the number of ticks to average ms by
    
    Returns:
    
    a string efficiently describing this ellapsed time.
  - parseMoneyStringSDL
```
public Triad<java.lang.String,java.lang.Double,java.lang.Long> parseMoneyStringSDL(MOB mob,
                                                                                   java.lang.String moneyStr,
                                                                                   java.lang.String correctCurrency)
```
    Description copied from interface: EnglishParsing
    
    For cases when a string input probably contains an amount of money, this method is used to determine the currency, denomination, and number of units of that currency. It will attempt to prefer whatever kind of currency the given mob has on hand.
    
    Specified by:
    
    parseMoneyStringSDL in interface EnglishParsing
    
    Parameters:
    
    mob - the user to use to find the right currency
    
    moneyStr - the parsable user input
    
    correctCurrency - a currency id to use, or null to use mob above
    
    Returns:
    
    the currency, denomination, and amount as a triad
  - parseMaxToGive
```
public int parseMaxToGive(MOB mob,
                          java.util.List<java.lang.String> commands,
                          boolean breakPackages,
                          Environmental checkWhat,
                          boolean getOnly)
```
    Description copied from interface: EnglishParsing
    
    Parses user input to determine if the user, who is specifying an item of some sort, is intending to specify multiples of those items by using a number in front of their input. For example: get 10 bags This parser assumes the thing being given might be in the players inventory, or on the ground. This might modify the given commands list.
    
    Specified by:
    
    parseMaxToGive in interface EnglishParsing
    
    Parameters:
    
    mob - the player to parse commands from
    
    commands - the parsed input from the user
    
    breakPackages - true to allow package breaking
    
    checkWhat - Possessor (MOB or Room) to check.
    
    getOnly - true if getting from a room
    
    Returns:
    
    -1 for error, or number to get 1-n.
  - probabilityOfBeingEnglish
```
public int probabilityOfBeingEnglish(java.lang.String str)
```
    Description copied from interface: EnglishParsing
    
    Returns the probability 0-100 of the given string being english. Used for Scholar stuff.
    
    Specified by:
    
    probabilityOfBeingEnglish in interface EnglishParsing
    
    Parameters:
    
    str - the text to inspect
    
    Returns:
    
    0-100 chance of it being english
  - fetchFlags
```
public EnglishParser.FetchFlags fetchFlags(java.lang.String srchStr)
```
  - cleanExtraneousDollarMarkers
```
protected java.lang.String cleanExtraneousDollarMarkers(java.lang.String srchStr)
```
  - fetchEnvironmental
```
public Environmental fetchEnvironmental(java.lang.Iterable<? extends Environmental> list,
                                        java.lang.String srchStr,
                                        boolean exactOnly)
```
    Description copied from interface: EnglishParsing
    
    Returns a matching environmental object from an iterable collection of them by using a search string to matching. The search string may include things like counters 1.itemname, etc, or even all itemname. The name matches may include object ids, names, or display text. Exact matches can be demanded using the anchor $ character on the front, back, or both, of the match words. Matching may be exact or inexact. Exact matching must include full names, display texts, etc. Inexact can include substrings. Both are case-insensitive, however.
    
    Specified by:
    
    fetchEnvironmental in interface EnglishParsing
    
    Parameters:
    
    list - the collection of environmental objects to search through
    
    srchStr - the search string
    
    exactOnly - true for exact matching, false for inexact
    
    Returns:
    
    a matching object, or null
  - fetchReflective
```
public <T> T fetchReflective(java.lang.Iterable<T> list,
                             java.lang.String srchStr,
                             java.lang.String methodName,
                             boolean exactOnly)
```
    Description copied from interface: EnglishParsing
    
    Returns a matching T object from an iterable collection of them by using a search string to matching. The search string may include things like counters 1.itemname, etc, or even all itemname. The object matches are according to given methodName. Exact matches can be demanded using the anchor $ character on the front, back, or both, of the match words. Matching may be exact or inexact. Exact matching must include full names, display texts, etc. Inexact can include substrings. Both are case-insensitive, however.
    
    Specified by:
    
    fetchReflective in interface EnglishParsing
    
    Type Parameters:
    
    T - the matching T object
    
    Parameters:
    
    list - the collection of environmental objects to search through
    
    srchStr - the search string
    
    methodName - the method to match against
    
    exactOnly - true for exact matching, false for inexact
    
    Returns:
    
    a matching object, or null
  - fetchExit
```
public Exit fetchExit(java.lang.Iterable<? extends Environmental> list,
                      java.lang.String srchStr,
                      boolean exactOnly)
```
    Description copied from interface: EnglishParsing
    
    Returns a matching exit object from an iterable collection of them by using a search string to matching. The search string may include things like counters 1.itemname, etc, or even all itemname. The name matches may include object ids, names, or display text. Exact matches can be demanded using the anchor $ character on the front, back, or both, of the match words. Matching may be exact or inexact. Exact matching must include full names, display texts, etc. Inexact can include substrings. Both are case-insensitive, however.
    
    Specified by:
    
    fetchExit in interface EnglishParsing
    
    Parameters:
    
    list - the collection of exit objects to search through
    
    srchStr - the search string
    
    exactOnly - true for exact matching, false for inexact
    
    Returns:
    
    a matching object, or null
  - fetchEnvironmental
```
public Environmental fetchEnvironmental(java.util.Iterator<? extends Environmental> iter,
                                        java.lang.String srchStr,
                                        boolean exactOnly)
```
    Description copied from interface: EnglishParsing
    
    Returns a matching environmental object from an iterator of them by using a search string to matching. The search string may include things like counters 1.itemname, etc, or even all itemname. The name matches may include object ids, names, or display text. Exact matches can be demanded using the anchor $ character on the front, back, or both, of the match words. Matching may be exact or inexact. Exact matching must include full names, display texts, etc. Inexact can include substrings. Both are case-insensitive, however.
    
    Specified by:
    
    fetchEnvironmental in interface EnglishParsing
    
    Parameters:
    
    iter - the iterator of objects to search through
    
    srchStr - the search string
    
    exactOnly - true for exact matching, false for inexact
    
    Returns:
    
    a matching object, or null
  - fetchEnvironmental
```
public Environmental fetchEnvironmental(java.util.Enumeration<? extends Environmental> iter,
                                        java.lang.String srchStr,
                                        boolean exactOnly)
```
    Description copied from interface: EnglishParsing
    
    Returns a matching environmental object from an enumeration of them by using a search string to matching. The search string may include things like counters 1.itemname, etc, or even all itemname. The name matches may include object ids, names, or display text. Exact matches can be demanded using the anchor $ character on the front, back, or both, of the match words. Matching may be exact or inexact. Exact matching must include full names, display texts, etc. Inexact can include substrings. Both are case-insensitive, however.
    
    Specified by:
    
    fetchEnvironmental in interface EnglishParsing
    
    Parameters:
    
    iter - the enumeraton of environmental objects to search through
    
    srchStr - the search string
    
    exactOnly - true for exact matching, false for inexact
    
    Returns:
    
    a matching object, or null
  - fetchEnvironmentals
```
public java.util.List<Environmental> fetchEnvironmentals(java.util.List<? extends Environmental> list,
                                                         java.lang.String srchStr,
                                                         boolean exactOnly)
```
    Description copied from interface: EnglishParsing
    
    Returns a set of matching environmental objects from a collection of them by using a search string to matching. The search string may include things like counters 1.itemname, etc, or even all itemname. The name matches may include object ids, names, or display text. Exact matches can be demanded using the anchor $ character on the front, back, or both, of the match words. Matching may be exact or inexact. Exact matching must include full names, display texts, etc. Inexact can include substrings. Both are case-insensitive, however.
    
    Specified by:
    
    fetchEnvironmentals in interface EnglishParsing
    
    Parameters:
    
    list - the list of objects to search through
    
    srchStr - the search string
    
    exactOnly - true for exact matching, false for inexact
    
    Returns:
    
    a set of matched objects
  - fetchEnvironmental
```
public Environmental fetchEnvironmental(java.util.Map<java.lang.String,? extends Environmental> list,
                                        java.lang.String srchStr,
                                        boolean exactOnly)
```
    Description copied from interface: EnglishParsing
    
    Returns a matching environmental object from map of them by using a search string to matching. The search string may include things like counters 1.itemname, etc, or even all itemname. The name matches may include object ids, names, or display text. Exact matches can be demanded using the anchor $ character on the front, back, or both, of the match words. Matching may be exact or inexact. Exact matching must include full names, display texts, etc. Inexact can include substrings. Both are case-insensitive, however.
    
    Specified by:
    
    fetchEnvironmental in interface EnglishParsing
    
    Parameters:
    
    list - the map of environmental objects to search through
    
    srchStr - the search string
    
    exactOnly - true for exact matching, false for inexact
    
    Returns:
    
    a matching object, or null
  - fetchAvailableItem
```
public Item fetchAvailableItem(java.util.List<Item> list,
                               java.lang.String srchStr,
                               Item goodLocation,
                               Filterer<Environmental> filter,
                               boolean exactOnly)
```
    Description copied from interface: EnglishParsing
    
    Returns a matching item from a collection of them by using a search string to matching, a required filter, and a container which may be null. The search string may include things like counters 1.itemname, etc, or even all itemname. The name matches may include item ids, names, or display text. Exact matches can be demanded using the anchor $ character on the front, back, or both, of the match words. Matching may be exact or inexact. Exact matching must include full names, display texts, etc. Inexact can include substrings. Both are case-insensitive, however.
    
    Specified by:
    
    fetchAvailableItem in interface EnglishParsing
    
    Parameters:
    
    list - the list of items to search through
    
    srchStr - the search string
    
    goodLocation - a container, or null
    
    filter - the required filter
    
    exactOnly - true for exact matching, false for inexact
    
    Returns:
    
    a matched item, or null
  - fetchAvailableItems
```
public java.util.List<Item> fetchAvailableItems(java.util.List<Item> list,
                                                java.lang.String srchStr,
                                                Item goodLocation,
                                                Filterer<Environmental> filter,
                                                boolean exactOnly)
```
    Description copied from interface: EnglishParsing
    
    Returns a set of matching items from a collection of them by using a search string to matching, a required filter, and a container which may be null. The search string may include things like counters 1.itemname, etc, or even all itemname. The name matches may include item ids, names, or display text. Exact matches can be demanded using the anchor $ character on the front, back, or both, of the match words. Matching may be exact or inexact. Exact matching must include full names, display texts, etc. Inexact can include substrings. Both are case-insensitive, however.
    
    Specified by:
    
    fetchAvailableItems in interface EnglishParsing
    
    Parameters:
    
    list - the list of items to search through
    
    srchStr - the search string
    
    goodLocation - a container, or null
    
    filter - the required filter
    
    exactOnly - true for exact matching, false for inexact
    
    Returns:
    
    all matched items
  - fetchAvailable
```
public Environmental fetchAvailable(java.util.Collection<? extends Environmental> list,
                                    java.lang.String srchStr,
                                    Item goodLocation,
                                    Filterer<Environmental> filter,
                                    boolean exactOnly,
                                    int[] counterSlap)
```
    Description copied from interface: EnglishParsing
    
    Returns a matching environmental object from a collection of them by using a search string to matching, a required filter, and for items, a container which may be null. The search string may include things like counters 1.itemname, etc, or even all itemname. The name matches may include object ids, names, or display text. Exact matches can be demanded using the anchor $ character on the front, back, or both, of the match words. Matching may be exact or inexact. Exact matching must include full names, display texts, etc. Inexact can include substrings. Both are case-insensitive, however. A one-dimensional integer array called counterSlap must be sent for tracking occurrences. The occurrence sought will have the existing counterSlap value subtracted from it before matching, and will be updated afterwards if a match is found.
    
    Specified by:
    
    fetchAvailable in interface EnglishParsing
    
    Parameters:
    
    list - the list of objects to search through
    
    srchStr - the search string
    
    goodLocation - a container, or null
    
    filter - the required filter
    
    exactOnly - true for exact matching, false for inexact
    
    counterSlap - a one-dimensional array, usually with 0
    
    Returns:
    
    a matched object, or null. counterslap is modified
  - fetchAvailable
```
public Environmental fetchAvailable(java.util.Collection<? extends Environmental> list,
                                    java.lang.String srchStr,
                                    Item goodLocation,
                                    Filterer<Environmental> filter,
                                    boolean exactOnly)
```
    Description copied from interface: EnglishParsing
    
    Returns a matching environmental object from a collection of them by using a search string to matching, a required filter, and for items, a container which may be null. The search string may include things like counters 1.itemname, etc, or even all itemname. The name matches may include object ids, names, or display text. Exact matches can be demanded using the anchor $ character on the front, back, or both, of the match words. Matching may be exact or inexact. Exact matching must include full names, display texts, etc. Inexact can include substrings. Both are case-insensitive, however.
    
    Specified by:
    
    fetchAvailable in interface EnglishParsing
    
    Parameters:
    
    list - the list of objects to search through
    
    srchStr - the search string
    
    goodLocation - a container, or null
    
    filter - the required filter
    
    exactOnly - true for exact matching, false for inexact
    
    Returns:
    
    a matched object, or null

Class EnglishParser

Nested Class Summary

Field Summary

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from interface java.lang.Comparable

Methods inherited from class java.lang.Object

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

Field Detail

PUNCTUATION_TABLE

NARROW_PUNCTUATION_TABLE

ARTICLES

INDARTICLES

ALL_CHRS

fwords

frwords

fnouns

feewords1

feewords2

num_words

num_words_10

num_words_x

numth_words

empty

Constructor Detail

EnglishParser

Method Detail

ID

toEnglishStringList

toEnglishStringList

toEnglishStringList

makeLowNumberWords

makeNumberthWords

makeNumberWords

makePastTense

isAnArticle

isAnIndefiniteArticle

makePlural

makeSingular

cleanPrepositions

properIndefiniteArticle

getBestDistance

sizeDescShort

distanceDescShort

coordDescShort

speedDescShort

directionDescShort

directionDescShortest

parseSpaceDistance

getFirstWord

startWithAorAn

startsWithAnArticle

startsWithAnIndefiniteArticle

removeArticleLead

insertUnColoredAdjective

skipSpaces

insertAdjectives

findSocial

findCommand

evokedBy

collapsedName

evokedBy

getSkillInvokeWord

getSkillToInvoke

preInvokeSkill

invokeSkill

isPunctuation

isEnglishPunctuation

hasEnglishPunctuation

stripEnglishPunctuation

hasPunctuation

stripPunctuation

spaceOutPunctuation

parseWords

equalsPunctuationless