org.apache.commons.events.observable
Class ModificationEventType

java.lang.Object
  org.apache.commons.events.observable.ModificationEventType

public class ModificationEventType
extends Object

Defines event constants for event handling and matching.

The constants in this class are of two types:

1. Methods - the base definitions (unique bits)
2. Groups - combination definitions (method bits combined)

Only a method constant may be compared using == to an event type. This can include use in a switch statement

Any constant may be used for filtering. They may combined using the bitwise OR, |. They may negated using the bitwise NOT, ~.

Since:

Commons Events 1.0

Version:

$Revision: 155443 $ $Date: 2005-02-26 13:19:51 +0000 (Sat, 26 Feb 2005) $

Author:

Stephen Colebourne

Field Summary

static int	ADD The method add(Object)
static int	ADD_ALL The method addAll(Collection)
static int	ADD_ALL_INDEXED The method addAll(int,Collection)
static int	ADD_INDEXED The method add(int,Object)
static int	ADD_ITERATED The method iterator.add(Object)
static int	ADD_NCOPIES The method add(Object,int)
static int	CLEAR The method clear()
static int	GROUP_ADD All add methods
static int	GROUP_ALL All methods
static int	GROUP_BULK All bulk methods (xxxAll, clear)
static int	GROUP_CHANGE All methods that change without structure modification
static int	GROUP_CLEAR All clear methods
static int	GROUP_FROM_BAG All methods sent by a Bag
static int	GROUP_FROM_BUFFER All methods sent by a Buffer
static int	GROUP_FROM_COLLECTION All methods sent by a Collection
static int	GROUP_FROM_LIST All methods sent by a List
static int	GROUP_FROM_SET All methods sent by a Set
static int	GROUP_INDEXED All indexed methods
static int	GROUP_ITERATED All iterated methods
static int	GROUP_NCOPIES All ncopies methods
static int	GROUP_NEXT All 'next' methods
static int	GROUP_NONE No methods
static int	GROUP_REDUCE All reducing methods (remove, retain and clear)
static int	GROUP_REMOVE All remove methods
static int	GROUP_RETAIN All retain methods
static int	GROUP_STRUCTURE_MODIFIED All methods that modify the structure
static int	REMOVE The method remove(Object)
static int	REMOVE_ALL The method removeAll(Collection)
static int	REMOVE_INDEXED The method remove(int)
static int	REMOVE_ITERATED The method iterator.remove()
static int	REMOVE_NCOPIES The method remove(Object,int)
static int	REMOVE_NEXT The method remove()
static int	RETAIN_ALL The method retainAll(Collection)
static int	SET_INDEXED The method set(int,Object)
static int	SET_ITERATED The method iterator.set(Object)

Constructor Summary

protected

ModificationEventType() Constructor.

Method Summary

static String

toString(int methodType) Gets a string version of a method event type.

Methods inherited from class java.lang.Object

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

Field Detail

ADD

public static final int ADD

The method add(Object)

See Also:

Constant Field Values

ADD_INDEXED

public static final int ADD_INDEXED

The method add(int,Object)

See Also:

Constant Field Values

ADD_NCOPIES

public static final int ADD_NCOPIES

The method add(Object,int)

See Also:

Constant Field Values

ADD_ITERATED

public static final int ADD_ITERATED

The method iterator.add(Object)

See Also:

Constant Field Values

ADD_ALL

public static final int ADD_ALL

The method addAll(Collection)

See Also:

Constant Field Values

ADD_ALL_INDEXED

public static final int ADD_ALL_INDEXED

The method addAll(int,Collection)

See Also:

Constant Field Values

REMOVE

public static final int REMOVE

The method remove(Object)

See Also:

Constant Field Values

REMOVE_INDEXED

public static final int REMOVE_INDEXED

The method remove(int)

See Also:

Constant Field Values

REMOVE_NCOPIES

public static final int REMOVE_NCOPIES

The method remove(Object,int)

See Also:

Constant Field Values

REMOVE_NEXT

public static final int REMOVE_NEXT

The method remove()

See Also:

Constant Field Values

REMOVE_ITERATED

public static final int REMOVE_ITERATED

The method iterator.remove()

See Also:

Constant Field Values

REMOVE_ALL

public static final int REMOVE_ALL

The method removeAll(Collection)

See Also:

Constant Field Values

RETAIN_ALL

public static final int RETAIN_ALL

The method retainAll(Collection)

See Also:

Constant Field Values

CLEAR

public static final int CLEAR

The method clear()

See Also:

Constant Field Values

SET_INDEXED

public static final int SET_INDEXED

The method set(int,Object)

See Also:

Constant Field Values

SET_ITERATED

public static final int SET_ITERATED

The method iterator.set(Object)

See Also:

Constant Field Values

GROUP_ADD

public static final int GROUP_ADD

All add methods

See Also:

Constant Field Values

GROUP_CHANGE

public static final int GROUP_CHANGE

All methods that change without structure modification

See Also:

Constant Field Values

GROUP_REMOVE

public static final int GROUP_REMOVE

All remove methods

See Also:

Constant Field Values

GROUP_RETAIN

public static final int GROUP_RETAIN

All retain methods

See Also:

Constant Field Values

GROUP_CLEAR

public static final int GROUP_CLEAR

All clear methods

See Also:

Constant Field Values

GROUP_REDUCE

public static final int GROUP_REDUCE

All reducing methods (remove, retain and clear)

See Also:

Constant Field Values

GROUP_INDEXED

public static final int GROUP_INDEXED

All indexed methods

See Also:

Constant Field Values

GROUP_NCOPIES

public static final int GROUP_NCOPIES

All ncopies methods

See Also:

Constant Field Values

GROUP_ITERATED

public static final int GROUP_ITERATED

All iterated methods

See Also:

Constant Field Values

GROUP_NEXT

public static final int GROUP_NEXT

All 'next' methods

See Also:

Constant Field Values

GROUP_BULK

public static final int GROUP_BULK

All bulk methods (xxxAll, clear)

See Also:

Constant Field Values

GROUP_STRUCTURE_MODIFIED

public static final int GROUP_STRUCTURE_MODIFIED

All methods that modify the structure

See Also:

Constant Field Values

GROUP_FROM_COLLECTION

public static final int GROUP_FROM_COLLECTION

All methods sent by a Collection

See Also:

Constant Field Values

GROUP_FROM_SET

public static final int GROUP_FROM_SET

All methods sent by a Set

See Also:

Constant Field Values

GROUP_FROM_LIST

public static final int GROUP_FROM_LIST

All methods sent by a List

See Also:

Constant Field Values

GROUP_FROM_BAG

public static final int GROUP_FROM_BAG

All methods sent by a Bag

See Also:

Constant Field Values

GROUP_FROM_BUFFER

public static final int GROUP_FROM_BUFFER

All methods sent by a Buffer

See Also:

Constant Field Values

GROUP_NONE

public static final int GROUP_NONE

No methods

See Also:

Constant Field Values

GROUP_ALL

public static final int GROUP_ALL

All methods

See Also:

Constant Field Values

Constructor Detail

ModificationEventType

protected ModificationEventType()

Constructor.

Method Detail

toString

public static String toString(int methodType)

Gets a string version of a method event type.

Parameters:

methodType - the method event type constant

Returns:

a string description