one.world.io
Class OptionEvent

java.lang.Object
  |
  +--one.world.core.Tuple
        |
        +--one.world.core.Event
              |
              +--one.world.util.TypedEvent
                    |
                    +--one.world.io.OptionEvent

All Implemented Interfaces:

Cloneable, Serializable

public class OptionEvent

extends TypedEvent

Implementation of an option event. Option events are used to set and get options for tuple storage. The options for a particular tuple store are always accessed as a whole and are persistently associated with that tuple store. When setting options for a tuple store, it is good practice to first retrieve the current options, modify them, and then set the modified options.

Version:

$Revision: 1.3 $

See Also:

Serialized Form

Field Summary

boolean	durable The durability flag.
static int	GET The type code for a get options request.
static int	OPTIONS The type code for an options response, which confirms both set and get option requests.
static int	SET The type code for a set options request.

Fields inherited from class one.world.util.TypedEvent

type

Fields inherited from class one.world.core.Event

closure, source

Fields inherited from class one.world.core.Tuple

CLOSURE, id, ID, META_DATA, metaData, SOURCE

Constructor Summary

OptionEvent()
Create a new, empty option event.

OptionEvent(EventHandler source, Object closure, int type, boolean durable)
Create a new option event.

Method Summary

void	validate() Validate this option event.

Methods inherited from class one.world.core.Tuple

clone, containsNonSymbolicHandler, equals, fields, get, getMetaData, getType, hasField, hashCode, hasMetaData, remove, set, setMetaData, toString, wrap

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SET

public static final int SET

The type code for a set options request.

GET

public static final int GET

The type code for a get options request.

OPTIONS

public static final int OPTIONS

The type code for an options response, which confirms both set and get option requests.

durable

public boolean durable

The durability flag. If a tuple store's durability flag is true all modifications, that is, all writes and deletes, are immediately written to persistent storage. If the flag is false, modifications may be collected in memory and flushed to persistent storage in periodic intervals. FlushEvents can be used to force this flushing. The default for newly created tuple stores is true.

Constructor Detail

OptionEvent

public OptionEvent()

Create a new, empty option event.

OptionEvent

public OptionEvent(EventHandler source,
                   Object closure,
                   int type,
                   boolean durable)

Create a new option event.

Parameters:

source - The source for the new option event.

closure - The closure for the new option event.

type - The type for the new option event.

durable - The durability flag for the new option event.

Method Detail

validate

public void validate()
              throws TupleException

Validate this option event.

Overrides:

validate in class Event

Following copied from class: one.world.core.Tuple

Throws:

TupleException - Signals that the tuple is either malformed (i.e., does not conform to the tuple specification) or invalid (i.e., does not conform to the semantic constraints of its type).

See Also:

MalformedTupleException, InvalidTupleException, Type.validate(Class)