Top Description Fields Constructors Methods
jakarta.mail.event

public Class StoreEvent

extends MailEvent
Class Inheritance
Imports
java.util.*, jakarta.mail.*
This class models notifications from the Store connection. These notifications can be ALERTS or NOTICES. ALERTS must be presented to the user in a fashion that calls the user's attention to the message.
Author
John Mani

Field Summary

Modifier and TypeField and Description
public static final int
ALERT

Indicates that this message is an ALERT.

protected String
message

The message text to be presented to the user.

public static final int
NOTICE

Indicates that this message is a NOTICE.

private static final long
serialVersionUID

Hides jakarta.mail.event.MailEvent.serialVersionUID.

protected int
type

The event type.

Constructor Summary

AccessConstructor and Description
public
StoreEvent(Store
the source Store
store, int
the event type
type, String
a message assoicated with the event
message)

Construct a StoreEvent.

Method Summary

Modifier and TypeMethod and Description
public void
dispatch(Object
the listener to invoke on
listener)

Implements abstract jakarta.mail.event.MailEvent.dispatch.

Invokes the appropriate StoreListener method.
public String

Returns:

message from the Store
getMessage()

Get the message from the Store.

public int

Returns:

type
getMessageType()

Return the type of this event.

Field Detail

ALERTback to summary
public static final int ALERT

Indicates that this message is an ALERT.

messageback to summary
protected String message

The message text to be presented to the user.

NOTICEback to summary
public static final int NOTICE

Indicates that this message is a NOTICE.

serialVersionUIDback to summary
private static final long serialVersionUID

Hides jakarta.mail.event.MailEvent.serialVersionUID.

typeback to summary
protected int type

The event type.

Constructor Detail

StoreEventback to summary
public StoreEvent(Store store, int type, String message)

Construct a StoreEvent.

Parameters
store:Store

the source Store

type:int

the event type

message:String

a message assoicated with the event

Method Detail

dispatchback to summary
public void dispatch(Object listener)

Implements abstract jakarta.mail.event.MailEvent.dispatch.

Invokes the appropriate StoreListener method.

Parameters
listener:Object

Doc from jakarta.mail.event.MailEvent.dispatch.

the listener to invoke on

Annotations
@Override
getMessageback to summary
public String getMessage()

Get the message from the Store.

Returns:String

message from the Store

getMessageTypeback to summary
public int getMessageType()

Return the type of this event.

Returns:int

type

See Also
ALERT, NOTICE