public class UsageException
extends java.lang.Exception
Constructor and Description |
---|
UsageException()
Creates a new UsageException.
|
UsageException(java.lang.String message)
Creates a new UsageException.
|
UsageException(java.lang.String message,
java.lang.Throwable cause)
Creates a new UsageException.
|
UsageException(java.lang.Throwable cause)
Creates a new UsageException.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getUsage()
Returns the usage message previously set.
|
void |
setUsage(java.lang.String usageText)
Attaches a usage message to the exception for later consumption.
|
public UsageException()
public UsageException(java.lang.String message)
message
- description of exceptional conditionpublic UsageException(java.lang.String message, java.lang.Throwable cause)
message
- description of exceptional conditioncause
- provoking exceptionpublic UsageException(java.lang.Throwable cause)
cause
- provoking exceptionpublic void setUsage(java.lang.String usageText)
usageText
- text to display to user to guide them to correct usage.
This is generated and set by the ArgsProcessor
.public java.lang.String getUsage()