oracle.javatools.resourcebundle
Class ResourceBundleEvent

java.lang.Object
  java.util.EventObject
      oracle.javatools.resourcebundle.ResourceBundleEvent

All Implemented Interfaces:

java.io.Serializable

public final class ResourceBundleEvent
extends java.util.EventObject

A ResourceBundleEvent is fired when the contents of a ResourceBundleWrapper changes. A ResourceBundleEvent object is sent as an argument to the ResourceBundleListner methods. A null value may be used in for either or both text and metadata when the values are not known, and always for REMOVED messages. key can only be null if the event type is UNKNOWN.

See Also:

Serialized Form

Nested Class Summary

static class

ResourceBundleEvent.EventType Type (ADDED, REMOVED, or MODIFIED) represented by this EventObject.

Field Summary

protected ResourceBundleEvent.EventType	eventType
protected java.lang.String	key
protected java.util.Map<java.lang.String,java.lang.String>	metadata
protected java.lang.String	text

Fields inherited from class java.util.EventObject

source

Constructor Summary

ResourceBundleEvent(ResourceBundleWrapper source)
Constructor for creating an UNKNOWN event

ResourceBundleEvent(ResourceBundleWrapper source, java.lang.String key, java.lang.String text, java.util.Map<java.lang.String,java.lang.String> metadata, ResourceBundleEvent.EventType eventType)
Constructs a new ResourceBundleEvent with the specified source, key, text, and metadata of the specified type.

Method Summary

java.lang.String	getKey() The key identified by this event.
java.util.Map<java.lang.String,java.lang.String>	getMetadata() The metdata identified by this event, or null
ResourceBundleWrapper	getSource() The ResourceBundleWrapper on which the Event initially occurred.
java.lang.String	getText() The new translatable text identified by this event, or null

Methods inherited from class java.util.EventObject

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

key

protected java.lang.String key

text

protected java.lang.String text

metadata

protected java.util.Map<java.lang.String,java.lang.String> metadata

eventType

protected ResourceBundleEvent.EventType eventType

Constructor Detail

ResourceBundleEvent

public ResourceBundleEvent(ResourceBundleWrapper source,
                           java.lang.String key,
                           java.lang.String text,
                           java.util.Map<java.lang.String,java.lang.String> metadata,
                           ResourceBundleEvent.EventType eventType)

Constructs a new ResourceBundleEvent with the specified source, key, text, and metadata of the specified type.

This method throws an IllegalArgumentExceptionif source or is null or keyis null and the event type is not UNKNOWN. textand metadatamay both be null.

Parameters:

source - The source ResourceBundleWrapper for this event.

key - The key represented by this event.

text - The translable text identified by the key.

metadata - Any metadata associated with the key.

eventType - Type of event.

See Also:

ResourceBundleWrapper, ResourceBundleEvent.EventType

ResourceBundleEvent

public ResourceBundleEvent(ResourceBundleWrapper source)

Constructor for creating an UNKNOWN event

Parameters:

source - The source ResourceBundleWrapper for this event.

Method Detail

getSource

public ResourceBundleWrapper getSource()

The ResourceBundleWrapper on which the Event initially occurred.

Overrides:

getSource in class java.util.EventObject

Returns:

The resource bundle on which the Event initially occurred.

getKey

public java.lang.String getKey()

The key identified by this event.

Returns:

The key identified by this event.

getText

public java.lang.String getText()

The new translatable text identified by this event, or null

Returns:

The new text or null

getMetadata

public java.util.Map<java.lang.String,java.lang.String> getMetadata()

The metdata identified by this event, or null

Returns:

The metdata identified by this event, or null