Class WarningEvent

Object

EventObject

StoreEvent

WarningEvent

All Implemented Interfaces:

Serializable, Localized

public class WarningEvent
extends StoreEvent

Describes non-fatal errors that occurred in a resource or a data store. The warning message is encapsulated in a Log­Record object, which allows the storage of various information (stack trace, thread identifier, log time, etc.) in addition of warning message.

Since:

1.0

See Also:

• Serialized Form

Field Summary

Fields inherited from class EventObject

source

Constructor Summary

Constructors

Constructor	Description
Warning­Event(Resource source, Log­Record description)	Constructs an event for a warning that occurred in the given resource.

Method Summary

Modifier and Type	Method	Description
Log­Record	get­Description()	Returns the warning message together with stack trace (if any) and other information.
String	get­Message(Locale locale)	Returns the warning message, preferably in the given locale.
String	to­String()	Returns a string representation of this warning for debugging purpose.

Methods inherited from class StoreEvent

consume, get­Locale, get­Source, is­Consumed

Modifier and Type	Method	Description
void	consume(boolean later)	Marks this event as consumed.
Locale	get­Locale()	Returns the locale associated with this event, or null if unspecified.
Resource	get­Source()	Returns the resource where the event occurred.
final boolean	is­Consumed()	Indicates whether this event has been consumed by any listener.

Methods inherited from class Object

clone, equals, finalize, get­Class, hash­Code, notify, notify­All, wait, wait, wait

Constructor Details

WarningEvent

public WarningEvent(Resource source,
 LogRecord description)

Constructs an event for a warning that occurred in the given resource.

Parameters:

source - the resource on which the warning initially occurred.

description - log record containing warning message, stack trace (if any) and other information.

Throws:

Illegal­Argument­Exception - if the given source is null.

Null­Pointer­Exception - if the given description is null.

Method Details

getDescription

public LogRecord getDescription()

Returns the warning message together with stack trace (if any) and other information.

Returns:

the log record containing warning message, stack trace and other information.

getMessage

public String getMessage(Locale locale)

Returns the warning message, preferably in the given locale. The locale is used on a best-effort basis and may be ignored if unsupported.

Parameters:

locale - the desired locale, or null for the default locale.

Returns:

the warning message, preferably in the given locale.

Since:

1.7

toString

public String toString()

Returns a string representation of this warning for debugging purpose.

Overrides:

to­String in class Event­Object

Returns:

a string representation of this warning.