co.cask.cdap.common.utils

Class UsageException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

co.cask.cdap.common.utils.UsageException

All Implemented Interfaces:

Serializable

public class UsageException
extends RuntimeException

This exception is only for bailing out of a command line tool when the command line arguments are not valid. In that case, we want to print a usage statement, but not an exception, and we also don't want to call System.exit(). So, when the program detects an error, it prints the help text and throws this exception. At the top level, we can catch this and exit without printing. We could use IllegalArgumentException instead, but we never know whether that was thrown somewhere else, in which case we want to print the exception.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UsageException()

Method Summary

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

UsageException

public UsageException()