org.jboss.logging.tools.examples

Interface ErrorMessages

All Known Implementing Classes:

ErrorMessages_$bundle

@MessageBundle(projectCode="CW")
 @BaseUrl(value="errors/")
public interface ErrorMessages

Common error messages for the application.

Author:

James R. Perkins

Field Summary

Fields

Modifier and Type	Field and Description
static ErrorMessages	MESSAGES The static message instance.

Method Summary

Modifier and Type	Method and Description
CloseException	closeFailure(Throwable cause, Closeable c) Creates an exception indicating a failure to close the Closeable
CloseException	closeFailure(Throwable cause, Closeable c, Throwable... errors) Creates an exception indicating a failure to close the Closeable
IllegalArgumentException	invalidValue(Object value) Creates an exception indicating the value is invalid.
Supplier<String>	nullParam(String name) Creates a message indicating the parameter is null.
<T extends RuntimeException> T	operationFailed(BiFunction<String,IOException,T> fn, IOException cause, String name) Uses the producer function to create the returned exception indicating the operation has failed.
<T extends RuntimeException> T	operationFailed(Function<String,T> fn, String name) Uses the producer function to create the returned exception indicating the operation has failed.
String	version(int major, int minor, int macro, String rel) Returns the internationalized version message.

Field Detail

MESSAGES

static final ErrorMessages MESSAGES

The static message instance.

Method Detail

version

@Message(value="Version %d.%d.%d.%s")
String version(int major,
                                                     int minor,
                                                     int macro,
                                                     String rel)

Returns the internationalized version message.

Parameters:

major - the major version

minor - the minor version

macro - the macro version

rel - the release suffix, e.g. Beta1, Final

Returns:

the formatted version

invalidValue

@Message(id=1,
         value="Value \'%s\' is invalid")
IllegalArgumentException invalidValue(Object value)

Creates an exception indicating the value is invalid.

Parameters:

value - the invalid value

Returns:

an IllegalStateException for the error

closeFailure

@Message(id=2,
         value="Failure closing %s")
CloseException closeFailure(@Cause
                                                                                Throwable cause,
                                                                                @Param @Pos(value=1)
                                                                                Closeable c)

Creates an exception indicating a failure to close the Closeable

Parameters:

cause - the cause of the error

c - the closeable that failed

Returns:

a CloseException for the error

closeFailure

CloseException closeFailure(@Cause
                            Throwable cause,
                            @Param @Pos(value=1)
                            Closeable c,
                            @Suppressed
                            Throwable... errors)

Creates an exception indicating a failure to close the Closeable

Parameters:

cause - the cause of the error

c - the closeable that failed

errors - errors that should be added as suppressed exceptions.

Returns:

a CloseException for the error

nullParam

@Message(id=3,
         value="Parameter %s cannot be null")
 @ResolutionDoc(suffix=".html")
Supplier<String> nullParam(String name)

Creates a message indicating the parameter is null.

This can be used to lazily format the message for null checks like Objects.requireNonNull(Object, Supplier).

Parameters:

name - the name of the parameter

Returns:

a supplier for the message

operationFailed

@Message(id=4,
         value="Operation %s failed.")
<T extends RuntimeException> T operationFailed(@Producer
                                                                                                     Function<String,T> fn,
                                                                                                     String name)

Uses the producer function to create the returned exception indicating the operation has failed.

The formatted value of the message will be the parameter for the functions apply method.

Type Parameters:

T - the type of the exception to return, must be assignable to a RuntimeException

Parameters:

fn - the function to produce the returned exception

name - the name of the operation that failed

Returns:

the produced exception for the error

operationFailed

<T extends RuntimeException> T operationFailed(@Producer
                                               BiFunction<String,IOException,T> fn,
                                               @Cause
                                               IOException cause,
                                               String name)

Uses the producer function to create the returned exception indicating the operation has failed.

The formatted value of the message will be the first parameter for the functions BiFunction.apply(Object, Object) apply} method. The second parameter will be the cause.

Type Parameters:

T - the type of the exception to return, must be assignable to a RuntimeException

Parameters:

fn - the function to produce the returned exception

cause - the cause of the exception to pass to the function

name - the name of the operation that failed

Returns:

the produced exception for the error