org.hyphenType.exit
Class ExitMessageException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by org.hyphenType.exit.ExitMessageException
All Implemented Interfaces:
Serializable

public class ExitMessageException
extends Exception

The base exception that is trapped when a main class is executed and that can be used to find exit codes. When an exception of this class or of a subclass of this class is thrown during the execution of a main class, hyphenType will try to find an exit status constant associated with the exception and use the arguments of this exception to format an error message. Association between exit status constants and exceptions is created using the Annotation.equals(Object) property, in the annotation that decorates an exit status constant.

Author:
akira
See Also:
Serialized Form

Constructor Summary
ExitMessageException(String... arguments)
          This constructor requires the caller to provide textual data that will be used to format error messages in exit status constants.
 
Method Summary
 String[] getArguments()
          Arguments to format error messages.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, 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

ExitMessageException

public ExitMessageException(String... arguments)
This constructor requires the caller to provide textual data that will be used to format error messages in exit status constants.

Parameters:
arguments - Arguments to format error messages.
Method Detail

getArguments

public String[] getArguments()
Arguments to format error messages.

Returns:
Arguments to format error messages


Copyright © 2013. All Rights Reserved.