Module jp.ecuacion.lib.core

Package jp.ecuacion.lib.core.exception.checked

Class AppWarningException

java.lang.Object

java.lang.Throwable

java.lang.Exception

jp.ecuacion.lib.core.exception.checked.AppWarningException

All Implemented Interfaces:

Serializable

public class AppWarningException
extends Exception

Provides an exception that indicates a warning.

This is used in web apps. When some business logic throws this warning exception, the app shows the warning popup window on screen and proceed when a user presses "OK".

It is not a child of AppException because AppException means an error occurred in a business logic but AppWarningException doesn't mean it.
Localized message is needed for this, so the class is the same constructure as BizLogicAppException.

MultipleAppException for warning does not seem to be needed so it does not exist.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected AppExceptionItemIds	itemIds	itemIds.
protected Locale	locale	locale.
protected String[]	messageArgs	message Arguments.
protected String	messageId	message ID.

Constructor Summary

Constructors

Constructor	Description
AppWarningException(String messageId, String... messageArgs)	Constructs a new instance with messageId and messageArgs.
AppWarningException(Locale locale, String messageId, String... messageArgs)	Constructs a new instance with warn itemIds, messageId and message Arguments.

Method Summary

Modifier and Type	Method	Description
Locale	getLocale()	Returns locale.
String[]	getMessageArgs()	Returns messageArgs.
String	getMessageId()	Returns messageId.
AppExceptionItemIds	itemIds()	Returns itemIds.
AppWarningException	itemIds(AppExceptionItemIds itemIds)	Sets itemIds and return this instance to realize the method chain.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, 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

Field Details

messageId

protected String messageId

message ID.

messageArgs

protected String[] messageArgs

message Arguments.

locale

protected Locale locale

locale.

itemIds

protected AppExceptionItemIds itemIds

itemIds.

Constructor Details

AppWarningException

public AppWarningException(@Nonnull
 String messageId,
 @Nonnull
 String... messageArgs)

Constructs a new instance with messageId and messageArgs.

Parameters:

messageId - message ID

messageArgs - message Arguments

AppWarningException

public AppWarningException(@RequireNonnull
 Locale locale,
 @Nonnull
 String messageId,
 @Nonnull
 String... messageArgs)

Constructs a new instance with warn itemIds, messageId and message Arguments.

Parameters:

locale - locale. May be null, which means default locale is used. designated.

messageId - messageId. Cannot be null.

messageArgs - message Arguments. May be null, which means no message arguments designated.

Method Details

getLocale

@Nonnull
public Locale getLocale()

Returns locale.

Returns:

locale

getMessageId

@Nonnull
public String getMessageId()

Returns messageId.

Returns:

message ID

getMessageArgs

@Nonnull
public String[] getMessageArgs()

Returns messageArgs.

Returns:

message arguments

itemIds

@Nonnull
public AppExceptionItemIds itemIds()

Returns itemIds.

Returns:

itemIds

itemIds

@Nonnull
public AppWarningException itemIds(@Nullable
 AppExceptionItemIds itemIds)

Sets itemIds and return this instance to realize the method chain.

Returns:

AppWarningException