org.clapper.util.cmdline
Class CommandLineUsageException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          org.clapper.util.misc.NestedException
              org.clapper.util.cmdline.CommandLineException
                  org.clapper.util.cmdline.CommandLineUsageException

All Implemented Interfaces:

java.io.Serializable

public class CommandLineUsageException
extends CommandLineException

Thrown by a command-line utility to indicate an error on the command line. The CommandLineUtility class intercepts this exception and displays the command's usage summary.

Version:

$Revision: 6735 $

Author:

Copyright © 2004-2007 Brian M. Clapper

See Also:

Serialized Form

Constructor Summary

CommandLineUsageException()
Default constructor, for an exception with no nested exception and no message.

CommandLineUsageException(java.lang.String message)
Constructs an exception containing an error message, but no nested exception.

CommandLineUsageException(java.lang.String bundleName, java.lang.String messageKey, java.lang.String defaultMsg)
Constructs an exception containing a resource bundle name, a message key, and a default message (in case the resource bundle can't be found).

CommandLineUsageException(java.lang.String bundleName, java.lang.String messageKey, java.lang.String defaultMsg, java.lang.Object[] msgParams)
Constructs an exception containing a resource bundle name, a message key, and a default message (in case the resource bundle can't be found).

CommandLineUsageException(java.lang.String bundleName, java.lang.String messageKey, java.lang.String defaultMsg, java.lang.Object[] msgParams, java.lang.Throwable exception)
Constructs an exception containing a resource bundle name, a message key, a default message format (in case the resource bundle can't be found), arguments to be incorporated in the message via java.text.MessageFormat, and another exception.

CommandLineUsageException(java.lang.String bundleName, java.lang.String messageKey, java.lang.String defaultMsg, java.lang.Throwable exception)
Constructs an exception containing a resource bundle name, a message key, a default message (in case the resource bundle can't be found), and another exception.

CommandLineUsageException(java.lang.String message, java.lang.Throwable exception)
Constructs an exception containing another exception and a message.

CommandLineUsageException(java.lang.Throwable exception)
Constructs an exception containing another exception, but no message of its own.

Method Summary

Methods inherited from class org.clapper.util.misc.NestedException

getMessage, getMessage, getMessages, getMessages, getMessages, getNestedException, printStackTrace, printStackTrace, printStackTrace, printStackTrace, printStackTrace, printStackTrace, toString

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, setStackTrace

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandLineUsageException

public CommandLineUsageException()

Default constructor, for an exception with no nested exception and no message.

CommandLineUsageException

public CommandLineUsageException(java.lang.Throwable exception)

Constructs an exception containing another exception, but no message of its own.

Parameters:

exception - the exception to contain

CommandLineUsageException

public CommandLineUsageException(java.lang.String message)

Constructs an exception containing an error message, but no nested exception.

Parameters:

message - the message to associate with this exception

CommandLineUsageException

public CommandLineUsageException(java.lang.String message,
                                 java.lang.Throwable exception)

Constructs an exception containing another exception and a message.

Parameters:

message - the message to associate with this exception

exception - the exception to contain

CommandLineUsageException

public CommandLineUsageException(java.lang.String bundleName,
                                 java.lang.String messageKey,
                                 java.lang.String defaultMsg)

Constructs an exception containing a resource bundle name, a message key, and a default message (in case the resource bundle can't be found). Using this constructor is equivalent to calling the CommandLineUsageException(String,String,String,Object[]) constructor, with a null pointer for the Object[] parameter. Calls to NestedException.getMessage(java.util.Locale) will attempt to retrieve the top-most message (i.e., the message from this exception, not from nested exceptions) by querying the named resource bundle. Calls to NestedException.printStackTrace(PrintWriter,java.util.Locale) will do the same, where applicable. The message is not retrieved until one of those methods is called, because the desired locale is passed into getMessage() and printStackTrace(), not this constructor.

Parameters:

bundleName - resource bundle name

messageKey - the key to the message to find in the bundle

defaultMsg - the default message

See Also:

CommandLineUsageException(String,String,String,Object[]), NestedException.getMessage(java.util.Locale)

CommandLineUsageException

public CommandLineUsageException(java.lang.String bundleName,
                                 java.lang.String messageKey,
                                 java.lang.String defaultMsg,
                                 java.lang.Object[] msgParams)

Constructs an exception containing a resource bundle name, a message key, and a default message (in case the resource bundle can't be found). Using this constructor is equivalent to calling the CommandLineUsageException(String,String,String,Object[],Throwable) constructor, with a null pointer for the Throwable parameter. Calls to NestedException.getMessage(java.util.Locale) will attempt to retrieve the top-most message (i.e., the message from this exception, not from nested exceptions) by querying the named resource bundle. Calls to NestedException.printStackTrace(PrintWriter,java.util.Locale) will do the same, where applicable. The message is not retrieved until one of those methods is called, because the desired locale is passed into getMessage() and printStackTrace(), not this constructor.

Parameters:

bundleName - resource bundle name

messageKey - the key to the message to find in the bundle

defaultMsg - the default message

msgParams - parameters to the message, if any, or null

See Also:

CommandLineUsageException(String,String,String,Object[]), NestedException.getMessage(java.util.Locale)

CommandLineUsageException

public CommandLineUsageException(java.lang.String bundleName,
                                 java.lang.String messageKey,
                                 java.lang.String defaultMsg,
                                 java.lang.Throwable exception)

Constructs an exception containing a resource bundle name, a message key, a default message (in case the resource bundle can't be found), and another exception. Using this constructor is equivalent to calling the CommandLineUsageException(String,String,String,Object[],Throwable) constructor, with a null pointer for the Object[] parameter. Calls to NestedException.getMessage(java.util.Locale) will attempt to retrieve the top-most message (i.e., the message from this exception, not from nested exceptions) by querying the named resource bundle. Calls to NestedException.printStackTrace(PrintWriter,java.util.Locale) will do the same, where applicable. The message is not retrieved until one of those methods is called, because the desired locale is passed into getMessage() and printStackTrace(), not this constructor.

Parameters:

bundleName - resource bundle name

messageKey - the key to the message to find in the bundle

defaultMsg - the default message

exception - the exception to nest

See Also:

CommandLineUsageException(String,String,String,Object[]), NestedException.getMessage(java.util.Locale)

CommandLineUsageException

public CommandLineUsageException(java.lang.String bundleName,
                                 java.lang.String messageKey,
                                 java.lang.String defaultMsg,
                                 java.lang.Object[] msgParams,
                                 java.lang.Throwable exception)

Constructs an exception containing a resource bundle name, a message key, a default message format (in case the resource bundle can't be found), arguments to be incorporated in the message via java.text.MessageFormat, and another exception. Calls to NestedException.getMessage(java.util.Locale) will attempt to retrieve the top-most message (i.e., the message from this exception, not from nested exceptions) by querying the named resource bundle. Calls to NestedException.printStackTrace(PrintWriter,java.util.Locale) will do the same, where applicable. The message is not retrieved until one of those methods is called, because the desired locale is passed into getMessage() and printStackTrace(), not this constructor.

Parameters:

bundleName - resource bundle name

messageKey - the key to the message to find in the bundle

defaultMsg - the default message

msgParams - parameters to the message, if any, or null

exception - exception to be nested

See Also:

CommandLineUsageException(String,String,String,Object[]), NestedException.getMessage(java.util.Locale)