com.github.jasonmfehr.tojs.exception

Class AbstractParameterizedException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.github.jasonmfehr.tojs.exception.AbstractParameterizedException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

DirectoryCreationException, FileCreationException, FileExistsException, FileReadException, FileSystemLocationNotFound, FileWriteException, NoResourcesFoundException, NotAssignableException, NotReadableException, NotWriteableException, ObjectInstantiationException

public abstract class AbstractParameterizedException
extends RuntimeException

Base class for any exceptions that have a single variable parameter within the exception message. Builds the exception message using the subclass's unique error message obtained by calling getExceptionMessage(). Any instances of the string PARAMETER_PLACEHOLDER will be replaced by the location provided in the constructor.

Subclasses dealing with file system operations are encouraged to include either the word Directory or File in their class names to help the user distinguish if the issue is with a directory or a non-directory normal file location.

Since:

1.0.0

Author:

jasonmfehr

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	PARAMETER_PLACEHOLDER

Constructor Summary

Constructors

Constructor and Description
AbstractParameterizedException(String parameter) Constructor.
AbstractParameterizedException(String parameter, Throwable cause) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract String	getExceptionMessage()
String	getMessage()
String	getParameter()

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, 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

Field Detail

PARAMETER_PLACEHOLDER

protected static final String PARAMETER_PLACEHOLDER

See Also:

Constant Field Values

Constructor Detail

AbstractParameterizedException

public AbstractParameterizedException(String parameter)

Constructor.

Parameters:

parameter - String containing the value of the parameter for the message

AbstractParameterizedException

public AbstractParameterizedException(String parameter,
                              Throwable cause)

Constructor.

Parameters:

parameter - String containing the value of the parameter for the message

cause - Throwable containing the exception that was the reason for this exception being created

Method Detail

getExceptionMessage

protected abstract String getExceptionMessage()

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

getParameter

public String getParameter()