net.sf.mmm.search.api

Class SearchException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

net.sf.mmm.util.exception.api.NlsRuntimeException

net.sf.mmm.search.api.SearchException

All Implemented Interfaces:

Serializable, Cloneable, NlsThrowable, AttributeReadMessage, AttributeReadMessageCode, AttributeReadUuid, NlsObject

Direct Known Subclasses:

SearchAddFailedException, SearchEntryIdImmutableException, SearchQueryParseException, SearchRemoveFailedException, SearchUpdateMissingIdException

public abstract class SearchException
extends NlsRuntimeException

This is a technical exception that can be thrown by the SearchEngine and related objects. The SearchEngine implementation is suggested to be tolerant (e.g. accept malformed queries). Anyways in some situations (e.g. IOException) it can be necessary to throw an exception. Therefore this is the suggested exception type to be used.

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	KEY_ENTRY Key for the argument "entry".
private static long	serialVersionUID UID for serialization.

Fields inherited from interface net.sf.mmm.util.nls.api.NlsObject

KEY_ANNOTATION, KEY_ARGUMENT, KEY_CAPACITY, KEY_CONTAINER, KEY_DEFAULT, KEY_DIRECTORY, KEY_ERROR, KEY_EXISTING, KEY_EXPECTED, KEY_FILE, KEY_FUNCTION, KEY_ID, KEY_KEY, KEY_LOCATION, KEY_MAX, KEY_MIN, KEY_MODE, KEY_NAME, KEY_OBJECT, KEY_OPERAND, KEY_OPERATION, KEY_OPTION, KEY_PATH, KEY_PROPERTY, KEY_QUERY, KEY_RESOURCE, KEY_SIZE, KEY_SOURCE, KEY_TARGET_TYPE, KEY_TITLE, KEY_TYPE, KEY_URI, KEY_USER, KEY_VALUE

Constructor Summary

Constructors

Constructor and Description
SearchException(NlsMessage message) The constructor.
SearchException(String internationalizedMessage) The constructor.
SearchException(Throwable nested, NlsMessage message) The constructor.

Method Summary

Modifier and Type	Method and Description
protected static NlsBundleSearchRoot	getBundle()

Methods inherited from class net.sf.mmm.util.exception.api.NlsRuntimeException

createBundle, createCopy, createCopyViaClone, createUuid, getCode, getLocalizedMessage, getLocalizedMessage, getLocalizedMessage, getMessage, getNlsMessage, getUuid, isForUser, isTechnical, printStackTrace, toNlsMessage, toString, toString, toString

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.mmm.util.exception.api.NlsThrowable

getCause, getStackTrace

Field Detail

serialVersionUID

private static final long serialVersionUID

UID for serialization.

See Also:

Constant Field Values

KEY_ENTRY

protected static final String KEY_ENTRY

Key for the argument "entry".

See Also:

Constant Field Values

Constructor Detail

SearchException

public SearchException(String internationalizedMessage)

The constructor.

Parameters:

internationalizedMessage - is a short description of the problem. It is used for internationalization and should be in English language.

SearchException

public SearchException(NlsMessage message)

The constructor.

Parameters:

message - the message describing the problem briefly.

SearchException

public SearchException(Throwable nested,
                       NlsMessage message)

The constructor.

Parameters:

nested - is the cause of this exception.

message - the message describing the problem briefly.

Method Detail

getBundle

protected static NlsBundleSearchRoot getBundle()

Returns:

the default bundle NlsBundleSearchRoot.