com.swath.cmd

Class UpgradePlanet

java.lang.Object

com.swath.Info

com.swath.cmd.UpgradePlanet

All Implemented Interfaces:

CommandIfc

public final class UpgradePlanet
extends Info

Upgrades the current planet to the next level if possible.
Prompts: Planet and Citadel prompt

Since:

SWATH 1.6.2

Method Summary

Modifier and Type	Method and Description
static boolean	exec() Upgrades the current planet to the next level if possible.
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

Method Detail

initCommand

public boolean initCommand()
                    throws java.lang.Exception

Throws:

java.lang.Exception

exec

public static boolean exec()
                    throws java.lang.Exception

Upgrades the current planet to the next level if possible. If the upgrade attempt fails, the upgradeStatus() method will tell you if the planet is upgrading or not. If the planet is not upgrading, the number of products and colonists needed for upgrading the planet is available from the upgradeAmountsNeeded() method.

Returns:

true if successful, otherwise false.

Throws:

java.lang.Exception

Since:

SWATH 1.6.2

See Also:

Planet.upgradeStatus(), Planet.upgradeAmountsNeeded()

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.