org.ceryle.wiki.plugin.assertion.filter
Class FilterException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by org.ceryle.wiki.plugin.query.QueryException
              extended by org.ceryle.wiki.plugin.assertion.AssertionException
                  extended by org.ceryle.wiki.plugin.assertion.filter.FilterException
All Implemented Interfaces:
Serializable

public class FilterException
extends AssertionException

Extends AssertionException as a simple typed exception for use by assertion/association filters.

Author:
Murray Altheim
See Also:
Serialized Form

Field Summary
static int FILTER_ERROR
          An exception type constant indicating an error occurring during assertion processing.
 
Fields inherited from class org.ceryle.wiki.plugin.assertion.AssertionException
MULTIPLE_UNDEFINED, OBJECT_UNDEFINED, PAGE_DOES_NOT_EXIST, PAGENAME_UNDEFINED, PREDICATE_UNDEFINED, PROCESS_ERROR, SUBJECT_UNDEFINED, TEMPLATE_ERROR, TERM_UNDEFINED
 
Fields inherited from class org.ceryle.wiki.plugin.query.QueryException
GRAMMAR_ERROR, m_type, PARAMETER_ERROR, QUERY_ERROR, SYNTAX_ERROR, UNKNOWN_ERROR
 
Constructor Summary
FilterException(int type)
          Constructor for an FilterException with a type and no message.
FilterException(int type, String message)
          Constructor for an FilterException with a type and message.
FilterException(String pagename, int type)
          Constructor for an FilterException with an optional page name, a type, and no message.
FilterException(String pagename, int type, String message)
          Constructor for an FilterException with an optional page name, a type, and message.
 
Method Summary
static String getTypeDescription(int type, Throwable throwable)
          Return a textual description of the exception type, suitable as an exception "title".
protected  void setType(int type)
          Sets the type of this FilterException.
 
Methods inherited from class org.ceryle.wiki.plugin.assertion.AssertionException
getObject, getPageName, getPredicate, getSubject, getTypeDescription
 
Methods inherited from class org.ceryle.wiki.plugin.query.QueryException
getType
 
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
 

Field Detail

FILTER_ERROR

public static final int FILTER_ERROR
An exception type constant indicating an error occurring during assertion processing.

See Also:
Constant Field Values
Constructor Detail

FilterException

public FilterException(int type)
Constructor for an FilterException with a type and no message. The unlocalized message will be set to the value provided from getTypeDescription(int,Throwable).


FilterException

public FilterException(String pagename,
                       int type)
Constructor for an FilterException with an optional page name, a type, and no message. Note the parameter order. The unlocalized message will be set to the value provided from getTypeDescription(int,Throwable).


FilterException

public FilterException(int type,
                       String message)
Constructor for an FilterException with a type and message.


FilterException

public FilterException(String pagename,
                       int type,
                       String message)
Constructor for an FilterException with an optional page name, a type, and message.

Method Detail

setType

protected void setType(int type)
Sets the type of this FilterException.

Overrides:
setType in class AssertionException

getTypeDescription

public static String getTypeDescription(int type,
                                        Throwable throwable)
Return a textual description of the exception type, suitable as an exception "title". This is localized only to English. For other localizations, use the page name and int type values. The optional throwable is used only for untyped/unknown exceptions to indicate the Exception class.

Parameters:
type - the type of the description
throwable - an optional Throwable (e.g., Exception)
See Also:
FILTER_ERROR, AssertionException.getTypeDescription(int,Throwable)


The Ceryle Project. Copyright ©2001-2007 Murray Altheim, All Rights Reserved. See LICENSE included with distribution.