org.dishevelled.commandline

Class Usage

java.lang.Object

org.dishevelled.commandline.Usage

public final class Usage
extends Object

Usage string.

Author:

Michael Heuer

Method Summary

Modifier and Type	Method and Description
static void	usage(String header, String message, Throwable cause, CommandLine commandLine, ArgumentList arguments, OutputStream out) Generate an usage string to the specified output stream.
static void	usage(String message, Throwable cause, CommandLine commandLine, ArgumentList arguments, OutputStream out) Generate an usage string to the specified output stream.

Methods inherited from class java.lang.Object

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

Method Detail

usage

public static void usage(String message,
                         Throwable cause,
                         CommandLine commandLine,
                         ArgumentList arguments,
                         OutputStream out)

Generate an usage string to the specified output stream.

Parameters:

message - message

cause - cause

commandLine - command line

arguments - list of arguments

out - output stream, must not be null

usage

public static void usage(String header,
                         String message,
                         Throwable cause,
                         CommandLine commandLine,
                         ArgumentList arguments,
                         OutputStream out)

Generate an usage string to the specified output stream.

Parameters:

header - header

message - message

cause - cause

commandLine - command line

arguments - list of arguments

out - output stream, must not be null

Since:

1.1