Package com.planet_ink.coffee_mud.Commands

Class Export

java.lang.Object

com.planet_ink.coffee_mud.Commands.StdCommand

com.planet_ink.coffee_mud.Commands.Export

All Implemented Interfaces:

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

public class Export
extends StdCommand

Field Summary

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

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.Object	executeInternal(MOB mob, int metaFlags, java.lang.Object... args)	This method is used for making "insider" calls to the command.
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.lang.String	getCatalogData(java.util.Map<java.lang.String,?> found)
protected CMClass.CMObjectType	getItemSubType(java.lang.String subType, int fileNameCode, java.lang.String[] fileName)
void	reallyExport(MOB mob, Session S, java.lang.String fileName, java.lang.String xml)
boolean	securityCheck(MOB mob)	Whether this command is available to the given player

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, getArgumentSetIndex, getVisibleRoomTarget, I, ID, initializeClass, isOccupiedWithOtherWork, L, name, newInstance, preExecute, putInCommandlist

Constructor Detail

Export

public Export()

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

reallyExport

public void reallyExport(MOB mob,
                         Session S,
                         java.lang.String fileName,
                         java.lang.String xml)

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)

getItemSubType

protected CMClass.CMObjectType getItemSubType(java.lang.String subType,
                                              int fileNameCode,
                                              java.lang.String[] fileName)

getCatalogData

protected java.lang.String getCatalogData(java.util.Map<java.lang.String,?> found)

executeInternal

public java.lang.Object executeInternal(MOB mob,
                                        int metaFlags,
                                        java.lang.Object... args)
                                 throws java.io.IOException

Description copied from interface: Command

This method is used for making "insider" calls to the command. It's parameters and implementation can follow any rules you like. The engine will sometimes use these to make direct calls to the command implementations.

Specified by:

executeInternal in interface Command

Overrides:

executeInternal in class StdCommand

Parameters:

mob - the mob or player issueing the command

metaFlags - flags denoting how the command is being executed

args - a set of object parameters

Returns:

xml document, with filenameType=4, or null

Throws:

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

See Also:

args[0] = commandType: AREA, PLAYER, ROOM args[1] = subType: DATA, PLAYER, MOBS, ITEMS, WEAPONS, ARMOR args[2] = fileName: MEMORY, SCREEN, EMAIL args[3] = fileNameType (0=screen, 1=disk, 2=directory, 3=email, 4=memory) args[4] = Session args[5] = area args[6] = room

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.

securityCheck

public boolean securityCheck(MOB mob)

Description copied from interface: Command

Whether this command is available to the given player

Specified by:

securityCheck in interface Command

Overrides:

securityCheck in class StdCommand

Parameters:

mob - the player mob who might not even know about this command

Returns:

true if the command is available, and false if it is unknown