com.izforge.izpack.api.exception

Class NativeLibException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.izforge.izpack.api.exception.NativeLibException

All Implemented Interfaces:

Serializable

public class NativeLibException
extends Exception

A exception class which will be used from the native part of system dependent classes to signal exceptions. The native methods writes only symbolic error messages, the language dependant mapping will be done in this class.

Author:

Klaus Bartz

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NativeLibException() The constructor.
NativeLibException(int libErr, int osErr, String libString, String osString) Creates a NativeLibException with the given values.
NativeLibException(String message) Creates a NativeLibException with the given message.
NativeLibException(String message, Throwable cause) Creates a NativeLibException with the given message and cause.
NativeLibException(Throwable cause) Creates a NativeLibException with the given cause.

Method Summary

Modifier and Type	Method and Description
void	addArgument(String arg) Adds a string to the internal argument list.
static void	addResourceBundle(String bundlePath) Adds a resource bundle which contains localized error messages.
ArrayList<String>	getArguments() Returns the internal argument list.
int	getLibErr() Returns the number of the internal handled error.
String	getLibMessage() Returns the message of the internal handled error.
String	getLocalizedLibMessage() Returns the localized message of the internal handled error.
String	getMessage()
int	getOsErr() Returns the number of the system error.
String	getOsMessage() Returns the message of the system error.
String	reviseMsgWithArgs(String msg) Revise placeholder in the given message with the setted arguments

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

Constructor Detail

NativeLibException

public NativeLibException()

The constructor.

NativeLibException

public NativeLibException(String message)

Creates a NativeLibException with the given message.

Parameters:

message - to be used

NativeLibException

public NativeLibException(Throwable cause)

Creates a NativeLibException with the given cause.

Parameters:

cause - to be used

NativeLibException

public NativeLibException(String message,
                          Throwable cause)

Creates a NativeLibException with the given message and cause.

Parameters:

message - message to be used

cause - cause to be used

NativeLibException

public NativeLibException(int libErr,
                          int osErr,
                          String libString,
                          String osString)

Creates a NativeLibException with the given values.

Parameters:

libErr - identifier of the internal handled error

osErr - system error number

libString - message for the internal handled error

osString - system error message

Method Detail

addResourceBundle

public static void addResourceBundle(String bundlePath)

Adds a resource bundle which contains localized error messages. The bundlePath should contain a string with which the bundle is loadable with ResourceBundle.getBundle, may be the full class path to a ListResourceBundle. The localize is done by getBundle, therefore the path should not contain the locale substring. At a call to getMessage the bundle is searched with the libErrString as key. If it exist, the value of it is used by getMessage, else the libErrString self.

Parameters:

bundlePath - path of bundle without locale

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

getLibErr

public int getLibErr()

Returns the number of the internal handled error.

Returns:

the number of the internal handled error

getLibMessage

public String getLibMessage()

Returns the message of the internal handled error.

Returns:

the messager of the internal handled error

getLocalizedLibMessage

public String getLocalizedLibMessage()

Returns the localized message of the internal handled error.

Returns:

the localized message of the internal handled error

getOsErr

public int getOsErr()

Returns the number of the system error.

Returns:

the number of the system error

getOsMessage

public String getOsMessage()

Returns the message of the system error.

Returns:

the messager of the system error

addArgument

public void addArgument(String arg)

Adds a string to the internal argument list.

Parameters:

arg - string to be added to the internal argument list

getArguments

public ArrayList<String> getArguments()

Returns the internal argument list.

Returns:

the internal argument list

reviseMsgWithArgs

public String reviseMsgWithArgs(String msg)

Revise placeholder in the given message with the setted arguments

Parameters:

msg - message to be revised

Returns:

revised message