Package com.planet_ink.coffee_mud.Commands

Class CalendarCmd

java.lang.Object

com.planet_ink.coffee_mud.Commands.StdCommand

com.planet_ink.coffee_mud.Commands.CalendarCmd

All Implemented Interfaces:

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

public class CalendarCmd
extends StdCommand

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	CalendarCmd.CalCmd

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.util.Comparator<JournalEntry>	calendarSort
protected static java.lang.String[]	rlPrefixes

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

idConverter

Fields inherited from class com.planet_ink.coffee_mud.Commands.StdCommand

ID, noCoinFilter

Constructor Summary

Constructors

Constructor	Description
CalendarCmd()

Method Summary

Modifier and Type	Method	Description
boolean	canBeOrdered()	Whether a group leader or charmer can order their followers to do this command.
boolean	execute(MOB mob, java.util.List<java.lang.String> commands, int metaFlags)	This method actually performs the command, when the given parsed set of command-line words.
java.lang.String[]	getAccessWords()	Returns the set of command words, with the most public one first, that are entered by the user to initiate this command.
protected java.util.List<JournalEntry>	getCalendarByExpirationRange(MOB whoM, long fromTm, long toTm)
protected java.util.List<JournalEntry>	getCalendarByStartRange(MOB whoM, long fromTm, long toTm)
protected java.util.List<JournalEntry>	getCalendarByTimeStamps(MOB whoM, long fromTm, long toTm)
java.lang.String	getEvents(MOB M, java.util.List<JournalEntry> entries)
protected java.util.List<JournalEntry>	getGlobalCalendarByExpirationRange(long fromTm, long toTm)
protected java.util.List<JournalEntry>	getGlobalCalendarByStartRange(long fromTm, long toTm)
protected java.util.List<JournalEntry>	getGlobalCalendarByTimeStamps(long fromTm, long toTm)
long	getMillis(MOB mob, TimeClock.TimePeriod P, boolean rl)
protected TimeClock.TimePeriod	getTimePeriod(java.lang.String period, boolean[] rl)

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.Commands.StdCommand

actionsCost, canBeCancelled, checkArguments, checkedActionsCost, combatActionsCost, compareTo, copyOf, executeInternal, getArgumentSetIndex, getVisibleRoomTarget, I, ID, initializeClass, isOccupiedWithOtherWork, L, name, newInstance, preExecute, putInCommandlist, securityCheck

Field Detail

rlPrefixes

protected static final java.lang.String[] rlPrefixes

calendarSort

protected static final java.util.Comparator<JournalEntry> calendarSort

Constructor Detail

CalendarCmd

public CalendarCmd()

Method Detail

getAccessWords

public java.lang.String[] getAccessWords()

Description copied from interface: Command

Returns the set of command words, with the most public one first, that are entered by the user to initiate this command.

Specified by:

getAccessWords in interface Command

Overrides:

getAccessWords in class StdCommand

Returns:

the set of command words that the user enters

getGlobalCalendarByStartRange

protected java.util.List<JournalEntry> getGlobalCalendarByStartRange(long fromTm,
                                                                     long toTm)

getGlobalCalendarByExpirationRange

protected java.util.List<JournalEntry> getGlobalCalendarByExpirationRange(long fromTm,
                                                                          long toTm)

getGlobalCalendarByTimeStamps

protected java.util.List<JournalEntry> getGlobalCalendarByTimeStamps(long fromTm,
                                                                     long toTm)

getCalendarByStartRange

protected java.util.List<JournalEntry> getCalendarByStartRange(MOB whoM,
                                                               long fromTm,
                                                               long toTm)

getCalendarByExpirationRange

protected java.util.List<JournalEntry> getCalendarByExpirationRange(MOB whoM,
                                                                    long fromTm,
                                                                    long toTm)

getCalendarByTimeStamps

protected java.util.List<JournalEntry> getCalendarByTimeStamps(MOB whoM,
                                                               long fromTm,
                                                               long toTm)

getTimePeriod

protected TimeClock.TimePeriod getTimePeriod(java.lang.String period,
                                             boolean[] rl)

getMillis

public long getMillis(MOB mob,
                      TimeClock.TimePeriod P,
                      boolean rl)

getEvents

public java.lang.String getEvents(MOB M,
                                  java.util.List<JournalEntry> entries)

execute

public boolean execute(MOB mob,
                       java.util.List<java.lang.String> commands,
                       int metaFlags)
                throws java.io.IOException

Description copied from interface: Command

This method actually performs the command, when the given parsed set of command-line words. The commands list is almost always the set of strings, starting with the access word that triggered the command. Some commands have custom APIs however, that allow almost anything to be in the commands list, or even for the commands to be null. This method is not allowed to be called until the player or mob has satisfied the actionsCost requirements and the securityCheck

Specified by:

execute in interface Command

Overrides:

execute in class StdCommand

Parameters:

mob - the mob or player issueing the command

commands - usually the command words and parameters; a set of strings

metaFlags - flags denoting how the command is being executed

Returns:

whether the command was successfully executed. Is almost meaningless.

Throws:

java.io.IOException - usually means the player has dropped carrier

See Also:

Command.actionsCost(MOB, List), Command.securityCheck(MOB)

canBeOrdered

public boolean canBeOrdered()

Description copied from interface: Command

Whether a group leader or charmer can order their followers to do this command.

Specified by:

canBeOrdered in interface Command

Overrides:

canBeOrdered in class StdCommand

Returns:

whether this command can be ordered.