com.goldencode.p2j.util

Class ServerConnectHelper

java.lang.Object

com.goldencode.p2j.util.ServerConnectHelper

public class ServerConnectHelper
extends java.lang.Object

This is a helper class to bring to central point the options which can be passed to a connect like methods. The options are passed as a string to parseOptions(com.goldencode.p2j.util.character, java.util.Set<java.lang.String>, java.util.Set<java.lang.String>, java.util.Map<java.lang.String, java.lang.Integer>); using the list of valid options, this will be able to identify no-value options (which act like flags) and also options which must receive an int value.

The -pf file option can be used to read a set of options from a file, and override any existing ones.

Field Summary

Fields

Modifier and Type	Field and Description
private static CentralLogger	LOG Logger

Constructor Summary

Constructors

Constructor and Description
ServerConnectHelper()

Method Summary

Modifier and Type	Method and Description
static int	getInt(java.util.Map<java.lang.String,java.lang.String> parms, java.lang.String key, int def) Parse the value for the specified key as an int, or default to the specified value if the key does not exist.
static java.lang.String	getString(java.util.Map<java.lang.String,java.lang.String> parms, java.lang.String key, java.lang.String def) Get a string from the parameters map, using the specified key and defaulting to the specified value, if it does not exist.
static java.util.Map<java.lang.String,java.lang.String>	parseOptions(character options, java.util.Set<java.lang.String> knownOptions, java.util.Set<java.lang.String> noValueOptions, java.util.Map<java.lang.String,java.lang.Integer> intOptions) Parse and validate the given options; a map is returned with each parameters's value.
private static void	parseOptions(java.lang.String options, java.util.Set<java.lang.String> knownOptions, java.util.Set<java.lang.String> noValueOptions, java.util.Map<java.lang.String,java.lang.Integer> intOptions, java.util.Map<java.lang.String,java.lang.String> params) Parse and validate the given options; a map is returned with each parameters's value.
private static java.util.Map<java.lang.String,java.lang.String>	readPfFile(java.lang.String file, java.util.Set<java.lang.String> knownOptions, java.util.Set<java.lang.String> noValueOptions, java.util.Map<java.lang.String,java.lang.Integer> intOptions) Read the parameters configured in the given file.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final CentralLogger LOG

Logger

Constructor Detail

ServerConnectHelper

public ServerConnectHelper()

Method Detail

parseOptions

public static java.util.Map<java.lang.String,java.lang.String> parseOptions(character options,
                                                                            java.util.Set<java.lang.String> knownOptions,
                                                                            java.util.Set<java.lang.String> noValueOptions,
                                                                            java.util.Map<java.lang.String,java.lang.Integer> intOptions)

Parse and validate the given options; a map is returned with each parameters's value. If a parameter doesn't have a value, the map will contain null.

Parameters:

options - The options from which the parameters will be extracted.

knownOptions - Set of valid options.

noValueOptions - Set of options which require no argument, i.e. "flags".

intOptions - Set of options which requre an int argument.

Returns:

The parameter-to-value map.

parseOptions

private static void parseOptions(java.lang.String options,
                                 java.util.Set<java.lang.String> knownOptions,
                                 java.util.Set<java.lang.String> noValueOptions,
                                 java.util.Map<java.lang.String,java.lang.Integer> intOptions,
                                 java.util.Map<java.lang.String,java.lang.String> params)

Parse and validate the given options; a map is returned with each parameters's value. If a parameter doesn't have a value, the map will contain null.

Parameters:

options - The options from which the parameters will be extracted.

knownOptions - Set of valid options.

noValueOptions - Set of options which require no argument, i.e. "flags".

intOptions - Set of options which require an int argument.

params - The parameter-to-value map.

getInt

public static int getInt(java.util.Map<java.lang.String,java.lang.String> parms,
                         java.lang.String key,
                         int def)

Parse the value for the specified key as an int, or default to the specified value if the key does not exist.

Parameters:

parms - The options map.

key - The key to search.

def - The default value to return if the key does not exist.

Returns:

See above.

getString

public static java.lang.String getString(java.util.Map<java.lang.String,java.lang.String> parms,
                                         java.lang.String key,
                                         java.lang.String def)

Get a string from the parameters map, using the specified key and defaulting to the specified value, if it does not exist.

Parameters:

parms - The options map.

key - The key to search.

def - The default value to return if the key does not exist.

Returns:

See above.

readPfFile

private static java.util.Map<java.lang.String,java.lang.String> readPfFile(java.lang.String file,
                                                                           java.util.Set<java.lang.String> knownOptions,
                                                                           java.util.Set<java.lang.String> noValueOptions,
                                                                           java.util.Map<java.lang.String,java.lang.Integer> intOptions)

Read the parameters configured in the given file.

Parameters:

file - The file containing the parameters.

knownOptions - Set of valid options.

noValueOptions - Set of options which require no argument, i.e. "flags".

intOptions - Set of options which requre an int argument.

Returns:

A map containing the value for each parameter or null if there were problems reading the file.