Package VASSAL.launch

Class LaunchRequest

java.lang.Object

VASSAL.launch.LaunchRequest

All Implemented Interfaces:

Serializable

public class LaunchRequest
extends Object
implements Serializable

Encapsulates and parses command-line arguments. args and LaunchRequest.parseArgs(args).toArgs() are equivalent (though perhaps not equal) argument lists.

Since:

3.1.0

Author:

Joel Uckelman

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
List<String>	autoext
boolean	builtInModule
File	extension
File	game
File	importFile
long	key
VASSAL.launch.LaunchRequest.Mode	mode
File	module
int	port
boolean	standalone

Constructor Summary

Constructors

Constructor	Description
LaunchRequest()
LaunchRequest(LaunchRequest lr)
LaunchRequest(VASSAL.launch.LaunchRequest.Mode mode)
LaunchRequest(VASSAL.launch.LaunchRequest.Mode mode, File module)
LaunchRequest(VASSAL.launch.LaunchRequest.Mode mode, File module, File other)

Method Summary

Modifier and Type	Method	Description
protected static void	die(String key, String... vals)	Throws a LaunchRequestException.
static LaunchRequest	parseArgs(String[] args)	Parse an argument array to a LaunchRequest.
protected static void	setMode(LaunchRequest lr, VASSAL.launch.LaunchRequest.Mode mode)
String[]	toArgs()	Create an argument array equivalent to this LaunchRequest.

Methods inherited from class java.lang.Object

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

Field Details

mode

public VASSAL.launch.LaunchRequest.Mode mode

module

public File module

game

public File game

extension

public File extension

importFile

public File importFile

standalone

public boolean standalone

builtInModule

public boolean builtInModule

autoext

public List<String> autoext

port

public int port

key

public long key

Constructor Details

LaunchRequest

public LaunchRequest()

LaunchRequest

public LaunchRequest(VASSAL.launch.LaunchRequest.Mode mode)

LaunchRequest

public LaunchRequest(VASSAL.launch.LaunchRequest.Mode mode,
File module)

LaunchRequest

public LaunchRequest(VASSAL.launch.LaunchRequest.Mode mode,
File module,
File other)

LaunchRequest

public LaunchRequest(LaunchRequest lr)

Method Details

toArgs

public String[] toArgs()

Create an argument array equivalent to this LaunchRequest.

Returns:

an array which would be parsed to this LaunchRequest

parseArgs

public static LaunchRequest parseArgs(String[] args)
                               throws LaunchRequestException

Parse an argument array to a LaunchRequest.

Parameters:

args - an array of command-line arguments

Returns:

a LaunchRequest equivalent to args

Throws:

LaunchRequestException - when parsing fails

setMode

protected static void setMode(LaunchRequest lr,
VASSAL.launch.LaunchRequest.Mode mode)
                       throws LaunchRequestException

Throws:

LaunchRequestException

die

protected static void die(String key,
String... vals)
                   throws LaunchRequestException

Throws a LaunchRequestException.

Parameters:

key - Resources key

vals - Resources arguments

Throws:

LaunchRequestException - always