owltools.cli

Class Opts

java.lang.Object

owltools.cli.Opts

public class Opts
extends Object

Helper for easy handling of command line parameters and input.

Constructor Summary

Constructors

Constructor and Description
Opts(List<String> args) Create a new instance for the given command-line parameters.
Opts(String[] args) Create a new instance for the given command-line parameters.

Method Summary

Methods

Modifier and Type	Method and Description
void	fail() Send a fail.
boolean	hasArgs()
boolean	hasOpt(String opt) Check if the option flag is in the remaining parameters
boolean	hasOpts()
void	info(String params, String desc) Write an info.
boolean	isHelpMode()
boolean	nextArgIsHelp()
boolean	nextEq(Collection<String> eqs)
boolean	nextEq(String eq)
File	nextFile()
List<String>	nextList()
String	nextOpt()
String	peekArg()
void	setHelpMode(boolean helpMode)

Methods inherited from class java.lang.Object

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

Constructor Detail

Opts

public Opts(String[] args)

Create a new instance for the given command-line parameters.

Parameters:

args - command-line parameter array

Opts

public Opts(List<String> args)

Create a new instance for the given command-line parameters.

Parameters:

args - list of command-line parameters

Method Detail

setHelpMode

public void setHelpMode(boolean helpMode)

Parameters:

helpMode - the helpMode to set

isHelpMode

public boolean isHelpMode()

Returns:

the helpMode

hasArgs

public boolean hasArgs()

Returns:

true, if there are further parameters to handle.

hasOpts

public boolean hasOpts()

Returns:

if there is a next parameter, which is an option flag

hasOpt

public boolean hasOpt(String opt)

Check if the option flag is in the remaining parameters

Parameters:

opt -

Returns:

true, if one of the remaining parameters equals the given string.

nextEq

public boolean nextEq(String eq)

nextEq

public boolean nextEq(Collection<String> eqs)

nextList

public List<String> nextList()

nextOpt

public String nextOpt()

nextFile

public File nextFile()

peekArg

public String peekArg()

nextArgIsHelp

public boolean nextArgIsHelp()

fail

public void fail()

Send a fail. WARNING: This will terminate the VM. Do NOT use in a framework. Uses System.err to print the error message.

info

public void info(String params,
        String desc)

Write an info. WARNING: This will terminate the VM. Do NOT use in a framework. Uses System.out to print the message.

Parameters:

params -

desc -