de.susebox.jtopas

Class TokenizerPropertyEvent

java.lang.Object

de.susebox.jtopas.TokenizerPropertyEvent

public class TokenizerPropertyEvent
extends java.lang.Object

The class TokenizerPropertyEvent describes changes in TokenizerProperties objects. Instances of this class are produced by TokenizerProperties and passed to TokenizerPropertyListener objects that are registered with the issuing TokenizerProperties instance.

Author:

Heiko Blau

See Also:

TokenizerProperties, TokenizerPropertyListener

Field Summary

Fields

Modifier and Type	Field and Description
static byte	PROPERTY_ADDED A property has been added.
static byte	PROPERTY_MODIFIED A property has been modified.
static byte	PROPERTY_REMOVED A property has been removed.

Constructor Summary

Constructors

Constructor and Description
TokenizerPropertyEvent() The standard constructor initializes an emtpy event.
TokenizerPropertyEvent(int type, TokenizerProperty property) This constructor takes the type of the event and the TokenizerProperty that changed.
TokenizerPropertyEvent(int type, TokenizerProperty property, TokenizerProperty oldProperty) This constructor takes the type of the event and the TokenizerProperty that changed together with its old value.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object that) Redefinition of the well-known Object.equals(java.lang.Object) method.
TokenizerProperty	getOldProperty() Retrieving the property that was set before the modification.
TokenizerProperty	getProperty() Retrieving the property this event is reporting.
int	getType() Retrieving the event type.
void	setOldProperty(TokenizerProperty property) Setting the TokenizerProperty that was changed.
void	setProperty(TokenizerProperty property) Setting the TokenizerProperty the event is about.
void	setType(int type) Setting the event type.
java.lang.String	toString() Redefinition of the well-known Object.toString() method.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PROPERTY_ADDED

public static final byte PROPERTY_ADDED

A property has been added.

See Also:

Constant Field Values

PROPERTY_REMOVED

public static final byte PROPERTY_REMOVED

A property has been removed.

See Also:

Constant Field Values

PROPERTY_MODIFIED

public static final byte PROPERTY_MODIFIED

A property has been modified.

See Also:

Constant Field Values

Constructor Detail

TokenizerPropertyEvent

public TokenizerPropertyEvent()

The standard constructor initializes an emtpy event.

TokenizerPropertyEvent

public TokenizerPropertyEvent(int type,
                              TokenizerProperty property)

This constructor takes the type of the event and the TokenizerProperty that changed.

Parameters:

type - type of the event, one of the PROPERTY_... constants

property - the property that was added, removed or the new value of a modified one

TokenizerPropertyEvent

public TokenizerPropertyEvent(int type,
                              TokenizerProperty property,
                              TokenizerProperty oldProperty)

This constructor takes the type of the event and the TokenizerProperty that changed together with its old value.

Parameters:

type - type of the event, one of the PROPERTY_... constants

property - the property that was added, removed or the new value of a modified one

oldProperty - the old value of the property that modified

Method Detail

setType

public void setType(int type)

Setting the event type. Use one of the PROPERTY_... constants for the parameter.

Parameters:

type - the event type

See Also:

getType(), PROPERTY_ADDED, PROPERTY_REMOVED, PROPERTY_MODIFIED

getType

public int getType()

Retrieving the event type. This will usually be one of the PROPERTY_... constants.

Returns:

the type of the event

setProperty

public void setProperty(TokenizerProperty property)

Setting the TokenizerProperty the event is about.

Parameters:

property - the added, removed or modified TokenizerProperty

getProperty

public TokenizerProperty getProperty()

Retrieving the property this event is reporting.

Returns:

the TokenizerProperty that is added, removed or modified

setOldProperty

public void setOldProperty(TokenizerProperty property)

Setting the TokenizerProperty that was changed. This is a valid method for the event PROPERTY_MODIFIED.

Parameters:

property - the previously set TokenizerProperty

getOldProperty

public TokenizerProperty getOldProperty()

Retrieving the property that was set before the modification. The method returns null when the event is NOT PROPERTY_MODIFIED.

Returns:

the TokenizerProperty set before the modification

equals

public boolean equals(java.lang.Object that)

Redefinition of the well-known Object.equals(java.lang.Object) method.

Overrides:

equals in class java.lang.Object

Parameters:

that - compare this instance with that object

Returns:

true if the two object describe the same property, false otherwise

toString

public java.lang.String toString()

Redefinition of the well-known Object.toString() method.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this TokenizerProperty