com.swath.cmd

Class ShowDeployedMines

java.lang.Object

com.swath.Info

com.swath.cmd.ShowDeployedMines

All Implemented Interfaces:

CommandIfc

public final class ShowDeployedMines
extends Info

Show deployed mines.
Prompts: Command prompt

Since:

SWATH 1.7

Field Summary

Fields

Modifier and Type	Field and Description
static int	ARMID Armid mines.
static int	LIMPET Limpet mines.

Method Summary

Modifier and Type	Method and Description
static int[]	exec(int type) Show deployed mines.
java.lang.String	getClassName() Gets the command class name.
java.lang.String	getName() Gets the name of the command.
java.util.Enumeration	getParams() Gets the command parameters.
boolean	initCommand()
boolean	isInternal() Indicates if this is an internal SWATH command or not.
boolean	isUserDefined() Indicates if this command is user defined or not.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ARMID

public static final int ARMID

Armid mines.

See Also:

Constant Field Values

LIMPET

public static final int LIMPET

Limpet mines.

See Also:

Constant Field Values

Method Detail

initCommand

public boolean initCommand()
                    throws java.lang.Exception

Throws:

java.lang.Exception

exec

public static int[] exec(int type)
                  throws java.lang.Exception

Show deployed mines. If the type is LIMPET, the command will return all active limpets.

Parameters:

type - The type of mines to show: ARMID or LIMPET.

Returns:

An array with active limpet sectors if any.

Throws:

java.lang.Exception

Since:

SWATH 1.7

See Also:

ARMID, LIMPET

isUserDefined

public final boolean isUserDefined()

Description copied from interface: CommandIfc

Indicates if this command is user defined or not.

Specified by:

isUserDefined in interface CommandIfc

Returns:

true if user defined, otherwise false.

getName

public final java.lang.String getName()

Description copied from interface: CommandIfc

Gets the name of the command.

Specified by:

getName in interface CommandIfc

Returns:

The command name.

getClassName

public final java.lang.String getClassName()

Description copied from interface: CommandIfc

Gets the command class name.

Specified by:

getClassName in interface CommandIfc

Returns:

The class name.

getParams

public final java.util.Enumeration getParams()

Description copied from interface: CommandIfc

Gets the command parameters.

Specified by:

getParams in interface CommandIfc

Returns:

The command parameters.

isInternal

public boolean isInternal()

Description copied from interface: CommandIfc

Indicates if this is an internal SWATH command or not.

Specified by:

isInternal in interface CommandIfc

Returns:

true if internal, otherwise false.