Package org.hippoecm.hst.configuration.channel

Class ChannelException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.hippoecm.hst.configuration.channel.ChannelException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ChannelNotFoundException

public class ChannelException
extends RuntimeException

Thrown when a channel-related error occured. A channel exception has a type with a key that can be used for i18n of the error messages. A channel exception can also contain a number of parameters that can be used in the i18n error message. Which parameters are included should be documented in the method where the exception is thrown.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ChannelException.Type	Type of a channel exception.

Constructor Summary

Constructors

Constructor	Description
ChannelException(String message)
ChannelException(String message, Throwable cause)
ChannelException(String message, Throwable cause, ChannelException.Type type, String... parameters)
ChannelException(String message, ChannelException.Type type, String... parameters)

Method Summary

Modifier and Type	Method	Description
String[]	getParameters()
ChannelException.Type	getType()

Methods inherited from class java.lang.Throwable

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

Constructor Detail

ChannelException

public ChannelException(String message)

ChannelException

public ChannelException(String message,
                        Throwable cause)

ChannelException

public ChannelException(String message,
                        ChannelException.Type type,
                        String... parameters)

ChannelException

public ChannelException(String message,
                        Throwable cause,
                        ChannelException.Type type,
                        String... parameters)

Method Detail

getType

public ChannelException.Type getType()

getParameters

public String[] getParameters()