com.opendxl.databus.cli

Class CliUtils

java.lang.Object

com.opendxl.databus.cli.CliUtils

public class CliUtils
extends java.lang.Object

Facilities for command line options

Method Summary

Modifier and Type	Method and Description
static boolean	isValidPartitionNumber(java.lang.String partition) This method returns if a partition provided by the command line is valid
static void	printUsageAndFinish(joptsimple.OptionParser parser, java.lang.String message) This method is invoked when the command line made up by options and argument are ill formed or do not meet options spec.
static void	printUsageAndFinish(joptsimple.OptionParser parser, java.lang.String message, java.lang.Exception exception) This method is invoked when the command line made up by options and argument are ill formed or do not meet options spec.
static void	printUsageAndFinish(java.lang.String executionResult) Prints usage and exits without system error
static java.util.Properties	stringToMap(java.lang.String commaSeparatedValue) Get properties from comma-separated config String
static void	validateMandatoryOperationArgs(CommandLineOperation operationArgument, joptsimple.OptionParser parser, joptsimple.OptionSet options) This method validate the mandatory arguments for a specific operation

Methods inherited from class java.lang.Object

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

Method Detail

printUsageAndFinish

public static void printUsageAndFinish(java.lang.String executionResult)

Prints usage and exits without system error

Parameters:

executionResult - It represents the result of a command line operation

printUsageAndFinish

public static void printUsageAndFinish(joptsimple.OptionParser parser,
                                       java.lang.String message)

This method is invoked when the command line made up by options and argument are ill formed or do not meet options spec. Then , it shows the usage and exit with a error

Parameters:

parser - The utility capable to show the usage

message - Message Error

printUsageAndFinish

public static void printUsageAndFinish(joptsimple.OptionParser parser,
                                       java.lang.String message,
                                       java.lang.Exception exception)

This method is invoked when the command line made up by options and argument are ill formed or do not meet options spec. Then , it shows the usage and exit with a error

Parameters:

parser - The utility capable to show the usage

message - Message Error

exception - exception that caused this error

validateMandatoryOperationArgs

public static void validateMandatoryOperationArgs(CommandLineOperation operationArgument,
                                                  joptsimple.OptionParser parser,
                                                  joptsimple.OptionSet options)

This method validate the mandatory arguments for a specific operation

Parameters:

operationArgument - It represents a instance of --operation argument

parser - The utility capable to show the usage

options - Represents the set of options in the command line

stringToMap

public static java.util.Properties stringToMap(java.lang.String commaSeparatedValue)

Get properties from comma-separated config String

Parameters:

commaSeparatedValue - comma-separated values key1=vale1,key2=value2,...,keyN=valueN

Returns:

Properties instance

isValidPartitionNumber

public static boolean isValidPartitionNumber(java.lang.String partition)

This method returns if a partition provided by the command line is valid

Parameters:

partition - An argument for partition number.

Returns:

If the given partition String is a valid partition number