oracle.spatial.hadoop.vector.util

Class CmdArgsParser

java.lang.Object

oracle.spatial.hadoop.vector.util.CmdArgsParser

public class CmdArgsParser
extends java.lang.Object

A command line input parser used internally by the vector API

Author:

hsaucedo

Constructor Summary

Constructors

Constructor and Description
CmdArgsParser(java.lang.String[] args) Creates a new instance with the given arguments

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getAnonymousArgs()
java.lang.String	getArg(java.lang.String argName) Returns the string value of the given argument.
java.lang.String	getArg(java.lang.String argName, java.lang.String defaultValue) Returns the string value of the given argument.
java.lang.String[]	getArrayArg(java.lang.String argName, boolean required, java.lang.String[] defaultValue) Gets the string array value of an argument
java.lang.Boolean	getBooleanArg(java.lang.String argName, boolean required, java.lang.Boolean defaultValue) Gets the boolean value of an argument
boolean[]	getBooleanArrayArg(java.lang.String argName, boolean required, boolean[] defaultValue) Gets the boolean array value of an argument
java.lang.Class<?>	getClassArg(java.lang.String argName, boolean required, java.lang.Class<?> defaultValue) Gets the class value of an argument
java.lang.Double	getDoubleArg(java.lang.String argName, boolean required, java.lang.Double defaultValue) Gets the double value of an argument
double[]	getDoubleArrayArg(java.lang.String argName, boolean required, double[] defaultValue) Gets the double array value of an argument
java.lang.Integer	getIntArg(java.lang.String argName, boolean required, java.lang.Integer defaultValue) Gets the integer value of an argument
int[]	getIntArrayArg(java.lang.String argName, boolean required, int[] defaultValue) Gets the integer array value of an argument
java.lang.Long	getLongArg(java.lang.String argName, boolean required, java.lang.Long defaultValue) Gets the long value of an argument
long[]	getLongArrayArg(java.lang.String argName, boolean required, long[] defaultValue) Gets the long array value of an argument
java.lang.String	getRequiredArg(java.lang.String argName) Validates that the given argument exists and returns its string value.

Methods inherited from class java.lang.Object

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

Constructor Detail

CmdArgsParser

public CmdArgsParser(java.lang.String[] args)

Creates a new instance with the given arguments

Parameters:

args - command line arguments

Method Detail

getAnonymousArgs

public java.lang.String[] getAnonymousArgs()

getArg

public java.lang.String getArg(java.lang.String argName)

Returns the string value of the given argument.

Parameters:

argName - an argument name

Returns:

the value of the argument or null if it was not found

getArg

public java.lang.String getArg(java.lang.String argName,
                               java.lang.String defaultValue)

Returns the string value of the given argument.

Parameters:

argName - an argument name

defaultValue - the value to return in case the argument is not found

Returns:

the value of the argument or the default value

getArrayArg

public java.lang.String[] getArrayArg(java.lang.String argName,
                                      boolean required,
                                      java.lang.String[] defaultValue)

Gets the string array value of an argument

Parameters:

argName - the argument name

required - whether the argument is required or not. In case it is required and not found, an IllegalStateException will be thrown.

defaultValue - the default value used in case the argument is not found and not required.

Returns:

the argument value or the default value in case it was not found and is not required

getBooleanArg

public java.lang.Boolean getBooleanArg(java.lang.String argName,
                                       boolean required,
                                       java.lang.Boolean defaultValue)

Gets the boolean value of an argument

Parameters:

argName - the argument name

required - whether the argument is required or not. In case it is required and not found, an IllegalStateException will be thrown.

defaultValue - the default value used in case the argument is not found and not required.

Returns:

the argument value or the default value in case it was not found and is not required

getBooleanArrayArg

public boolean[] getBooleanArrayArg(java.lang.String argName,
                                    boolean required,
                                    boolean[] defaultValue)

Gets the boolean array value of an argument

Parameters:

argName - the argument name

required - whether the argument is required or not. In case it is required and not found, an IllegalStateException will be thrown.

defaultValue - the default value used in case the argument is not found and not required.

Returns:

the argument value or the default value in case it was not found and is not required

getClassArg

public java.lang.Class<?> getClassArg(java.lang.String argName,
                                      boolean required,
                                      java.lang.Class<?> defaultValue)

Gets the class value of an argument

Parameters:

argName - the argument name

required - whether the argument is required or not. In case it is required and not found, an IllegalStateException will be thrown.

defaultValue - the default value used in case the argument is not found and not required.

Returns:

the argument value or the default value in case it was not found and is not required

getDoubleArg

public java.lang.Double getDoubleArg(java.lang.String argName,
                                     boolean required,
                                     java.lang.Double defaultValue)

Gets the double value of an argument

Parameters:

argName - the argument name

required - whether the argument is required or not. In case it is required and not found, an IllegalStateException will be thrown.

defaultValue - the default value used in case the argument is not found and not required.

Returns:

the argument value or the default value in case it was not found and is not required

getDoubleArrayArg

public double[] getDoubleArrayArg(java.lang.String argName,
                                  boolean required,
                                  double[] defaultValue)

Gets the double array value of an argument

Parameters:

argName - the argument name

required - whether the argument is required or not. In case it is required and not found, an IllegalStateException will be thrown.

defaultValue - the default value used in case the argument is not found and not required.

Returns:

the argument value or the default value in case it was not found and is not required

getIntArg

public java.lang.Integer getIntArg(java.lang.String argName,
                                   boolean required,
                                   java.lang.Integer defaultValue)

Gets the integer value of an argument

Parameters:

argName - the argument name

required - whether the argument is required or not. In case it is required and not found, an IllegalStateException will be thrown.

defaultValue - the default value used in case the argument is not found and not required.

Returns:

the argument value or the default value in case it was not found and is not required

getIntArrayArg

public int[] getIntArrayArg(java.lang.String argName,
                            boolean required,
                            int[] defaultValue)

Gets the integer array value of an argument

Parameters:

argName - the argument name

required - whether the argument is required or not. In case it is required and not found, an IllegalStateException will be thrown.

defaultValue - the default value used in case the argument is not found and not required.

Returns:

the argument value or the default value in case it was not found and is not required

getLongArg

public java.lang.Long getLongArg(java.lang.String argName,
                                 boolean required,
                                 java.lang.Long defaultValue)

Gets the long value of an argument

Parameters:

argName - the argument name

required - whether the argument is required or not. In case it is required and not found, an IllegalStateException will be thrown.

defaultValue - the default value used in case the argument is not found and not required.

Returns:

the argument value or the default value in case it was not found and is not required

getLongArrayArg

public long[] getLongArrayArg(java.lang.String argName,
                              boolean required,
                              long[] defaultValue)

Gets the long array value of an argument

Parameters:

argName - the argument name

required - whether the argument is required or not. In case it is required and not found, an IllegalStateException will be thrown.

defaultValue - the default value used in case the argument is not found and not required.

Returns:

the argument value or the default value in case it was not found and is not required

getRequiredArg

public java.lang.String getRequiredArg(java.lang.String argName)

Validates that the given argument exists and returns its string value. If the argument is not present an IllegalStateException will be thrown

Parameters:

argName - an argument name

Returns:

the value of the argument