Package org.ka2ddo.yaac.core

Class HelpTaggedIOException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.io.IOException

org.ka2ddo.yaac.core.HelpTaggedIOException

All Implemented Interfaces:

Serializable, HelpTaggedException

public class HelpTaggedIOException
extends IOException
implements HelpTaggedException

This exception is the same as java.io.IOException, except that it carries a help tag so the error display code can provide additional documentation to the user.

Author:

Andrew Pavlin, KA2DDO

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
HelpTaggedIOException(String helpTag)	Constructs an IOException with null as its error detail message.
HelpTaggedIOException(String message, String helpTag)	Constructs an IOException with the specified detail message.
HelpTaggedIOException(String message, Throwable cause, String helpTag)	Constructs an IOException with the specified detail message and cause.
HelpTaggedIOException(Throwable cause, String helpTag)	Constructs an IOException with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).

Method Summary

Modifier and Type	Method	Description
String	getHelpTag()	Get the help tag for this exception.
final String	toString()	Returns a short description of this Exception.

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Constructor Details

HelpTaggedIOException

public HelpTaggedIOException(String helpTag)

Constructs an IOException with null as its error detail message.

Parameters:

helpTag - String identifying the JavaHelp tag for explaining this exception

HelpTaggedIOException

public HelpTaggedIOException(Throwable cause,
 String helpTag)

Constructs an IOException with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause). This constructor is useful for IO exceptions that are little more than wrappers for other throwables.

Parameters:

cause - The cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

helpTag - String identifying the JavaHelp tag for explaining this exception

HelpTaggedIOException

public HelpTaggedIOException(String message,
 String helpTag)

Constructs an IOException with the specified detail message.

Parameters:

message - The detail message (which is saved for later retrieval by the Throwable.getMessage() method)

helpTag - String identifying the JavaHelp tag for explaining this exception

HelpTaggedIOException

public HelpTaggedIOException(String message,
 Throwable cause,
 String helpTag)

Constructs an IOException with the specified detail message and cause.

Note that the detail message associated with cause is not automatically incorporated into this exception's detail message.

Parameters:

message - The detail message (which is saved for later retrieval by the Throwable.getMessage() method)

cause - The cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

helpTag - String identifying the JavaHelp tag for explaining this exception

Method Details

getHelpTag

public String getHelpTag()

Get the help tag for this exception.

Specified by:

getHelpTag in interface HelpTaggedException

Returns:

help tag String

toString

public final String toString()

Returns a short description of this Exception. The result is the concatenation of:

• the name of the superclass of this exception object
• ": " (a colon and a space)
• the result of invoking this object's Throwable.getLocalizedMessage() method

If getLocalizedMessage returns null, then just the class name is returned.

Overrides:

toString in class Throwable

Returns:

a string representation of this throwable.