step.encoding
Class IrregularValueEvent

java.lang.Object
  |
  +--step.encoding.EncoderEvent
        |
        +--step.encoding.IrregularValueEvent

All Implemented Interfaces:

MetaEvent, Serializable, StepObject, StepRecord

public class IrregularValueEvent

extends EncoderEvent

An event that signals that the next value in the data stream is irregular. The definition of an "irregular" value is specific to the particular encoding strategy.

See Also:

RegularValueStrategy, Serialized Form

Nested Class Summary

static class

IrregularValueEvent.Factory

Field Summary

static RecordDef

DEFINITION

Fields inherited from class step.encoding.EncoderEvent

target

Fields inherited from interface step.StepRecord

TYPE

Constructor Summary

IrregularValueEvent(StepString target)

Method Summary

void	applyToEncoder(Encoder encoder) Signal the target encoder that the next value is irregular.
boolean	equals(Object o) Compare to events for equality.
FieldIterator	fieldIterator() Get an iterator for serial access to this record's fields.
int	hashCode() Get a hash code for this object.

Methods inherited from class step.encoding.EncoderEvent

apply, toString

Methods inherited from class java.lang.Object

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

Field Detail

DEFINITION

public static final RecordDef DEFINITION

Constructor Detail

IrregularValueEvent

public IrregularValueEvent(StepString target)

Method Detail

applyToEncoder

public void applyToEncoder(Encoder encoder)

Signal the target encoder that the next value is irregular.

Specified by:

applyToEncoder in class EncoderEvent

Throws:

ClassCastException - if the target encoder is not a RegularValueStrategy.

equals

public boolean equals(Object o)

Compare to events for equality.

Specified by:

equals in interface StepObject

Overrides:

equals in class Object

Throws:

ClassCastException - if the object is not an IrregularValueEvent.

NullPointerException - if the object is null.

hashCode

public int hashCode()

Description copied from interface: StepObject

Get a hash code for this object.

NOTE: All STEP objects must be hashable to support the identifier encoding strategy.

Specified by:

hashCode in interface StepObject

Overrides:

hashCode in class Object

fieldIterator

public FieldIterator fieldIterator()

Description copied from interface: StepRecord

Get an iterator for serial access to this record's fields.

NOTE: The order in which fields are accessed by the iterator should be compatible with the factory associated with this record.

See Also:

RecordFactory