com.chemaxon.overlap.cli.util

Class CliUtil

java.lang.Object

com.chemaxon.overlap.cli.util.CliUtil

public final class CliUtil
extends Object

CLI related utilities for overlap-examples.

Method Summary

Modifier and Type	Method and Description
static ConsolePO	createConsolePo(PrintStream ps, String name, Prof prof) Create a progress observer and register if profiler is present.
static String	getMetricsHelp() Compose detailed help string on available metrics.
static String	getUsageString(Class<?> paramsClass) Get usage string of a given parameters object
static String	getUsageString(Class<?> paramsClass, String programNameOrNull) Get usage string of a given parameters object
static String	getUsageString(Object[] paramsObjects) Get usage string of a given parameters object
static <T> T	parseParameters(Class<T> paramsClass, String[] args) Parse parameters.
static void	parseParameters(Object[] paramsObjects, String[] args)
static PrintStream	printUsage(Class<?> paramsClass) Print usage of a given parameters object.
static PrintStream	printUsage(Object[] pa)

Methods inherited from class java.lang.Object

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

Method Detail

parseParameters

public static <T> T parseParameters(Class<T> paramsClass,
                                    String[] args)

Parse parameters.

Type Parameters:

T - Parameters type

Parameters:

paramsClass - Parameters type

args - Command line arguments

Returns:

Parsed parameters

parseParameters

public static void parseParameters(Object[] paramsObjects,
                                   String[] args)

getMetricsHelp

public static String getMetricsHelp()

Compose detailed help string on available metrics.

Returns:

Detailed help on available metrics.

getUsageString

public static String getUsageString(Class<?> paramsClass)

Get usage string of a given parameters object

Parameters:

paramsClass - Parameters object type

Returns:

Usage as String

getUsageString

public static String getUsageString(Class<?> paramsClass,
                                    String programNameOrNull)

Get usage string of a given parameters object

Parameters:

paramsClass - Parameters object type

programNameOrNull - When not null pass to JCommander.setProgramName(java.lang.String)

Returns:

Usage as String

getUsageString

public static String getUsageString(Object[] paramsObjects)

Get usage string of a given parameters object

Parameters:

paramsClass - Parameters object type

Returns:

Usage as String

printUsage

public static PrintStream printUsage(Class<?> paramsClass)

Print usage of a given parameters object.

Parameters:

paramsClass - Parameters object type

Returns:

PrintStream used to print

printUsage

public static PrintStream printUsage(Object[] pa)

createConsolePo

public static ConsolePO createConsolePo(PrintStream ps,
                                        String name,
                                        Prof prof)

Create a progress observer and register if profiler is present.

Parameters:

ps - Target to pass to ConsolePO.ConsolePO(java.io.PrintStream, java.lang.String)

name - Name to pass to ConsolePO.ConsolePO(java.io.PrintStream, java.lang.String)

prof - Profiler instance to register or null

Returns:

Observer