net.sf.mmm.util.io.api

Class RuntimeIoException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

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

net.sf.mmm.util.io.api.RuntimeIoException

All Implemented Interfaces:

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

Direct Known Subclasses:

FileAlreadyExistsException, FileAttributeModificationFailedException, FileCreationFailedException, FileDeletionFailedException, FileNotExistsException

public class RuntimeIoException
extends NlsRuntimeException

A RuntimeIoException is like an IOException but as a RuntimeException. Besides it has native language support build in.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	MESSAGE_CODE
private static long	serialVersionUID

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

Modifier	Constructor and Description
	RuntimeIoException() The constructor.
	RuntimeIoException(IoMode mode) The constructor.
protected	RuntimeIoException(NlsMessage message) The constructor.
	RuntimeIoException(Throwable nested) The constructor.
	RuntimeIoException(Throwable nested, IoMode mode) The constructor.
protected	RuntimeIoException(Throwable nested, NlsMessage message) The constructor.

Method Summary

Modifier and Type	Method and Description
String	getCode() This method gets the code that identifies the detailed type of this object.
private static NlsMessage	getMessage(IoMode mode) This method gets the message according to the given mode.

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

createBundle, createCopy, createCopyViaClone, createUuid, 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

See Also:

Constant Field Values

MESSAGE_CODE

public static final String MESSAGE_CODE

See Also:

getCode(), Constant Field Values

Constructor Detail

RuntimeIoException

public RuntimeIoException()

The constructor.

RuntimeIoException

public RuntimeIoException(IoMode mode)

The constructor.

Parameters:

mode - is the IoMode.

RuntimeIoException

public RuntimeIoException(Throwable nested)

The constructor.

Parameters:

nested - is the cause of this exception. This should be an IOException. However it may also be an IOError.

RuntimeIoException

public RuntimeIoException(Throwable nested,
                          IoMode mode)

The constructor.

Parameters:

nested - is the cause of this exception. This should be an IOException. However it may also be an IOError.

mode - is the IoMode.

RuntimeIoException

protected RuntimeIoException(NlsMessage message)

The constructor.

Parameters:

message - the message describing the problem briefly.

Since:

3.0.0

RuntimeIoException

protected RuntimeIoException(Throwable nested,
                             NlsMessage message)

The constructor.

Parameters:

nested - is the cause of this exception.

message - the message describing the problem briefly.

Since:

3.0.0

Method Detail

getMessage

private static NlsMessage getMessage(IoMode mode)

This method gets the message according to the given mode.

Parameters:

mode - is the IoMode or null if unknown.

Returns:

the message according to mode.

getCode

public String getCode()

Description copied from interface: AttributeReadMessageCode

This method gets the code that identifies the detailed type of this object. While UUID or ID are typically unique per instance of an object the code is unique for all instances of the exact same kind. So e.g. a particular kind of exception or ValidationFailure can be identified by its code. A simple generic implementation may return the classname or the key of the NLS message. However, the code should remain stable after refactoring (so at least after the rename the previous code should be returned as String literal). This code may be used as a compact identifier to reference the related problem or information as well as for automatic tests of error situations that should remain stable even if the message text gets improved or the locale is unknown.

Specified by:

getCode in interface AttributeReadMessageCode

Overrides:

getCode in class NlsRuntimeException

Returns:

the message text.

See Also:

Throwable.getMessage(), NlsThrowable, Message