step.encoding
Class EncoderMessageEvent

java.lang.Object
  |
  +--step.encoding.EncoderEvent
        |
        +--step.encoding.EncoderMessageEvent
All Implemented Interfaces:
MetaEvent, Serializable, StepObject, StepRecord

public class EncoderMessageEvent
extends EncoderEvent

An event that dispatches an arbitrary text message to an encoder.

See Also:
Encoder.eventMessage(String), Serialized Form

Nested Class Summary
static class EncoderMessageEvent.Factory
           
 
Field Summary
static RecordDef DEFINITION
           
 StepString message
          The message carried by this event.
 
Fields inherited from class step.encoding.EncoderEvent
target
 
Fields inherited from interface step.StepRecord
TYPE
 
Constructor Summary
EncoderMessageEvent(StepString target, StepString message)
           
 
Method Summary
 void applyToEncoder(Encoder encoder)
          Dispatch the message to the target encoder.
 boolean equals(Object o)
          Compare two 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

message

public StepString message
The message carried by this event.

Constructor Detail

EncoderMessageEvent

public EncoderMessageEvent(StepString target,
                           StepString message)
Method Detail

applyToEncoder

public void applyToEncoder(Encoder encoder)
Dispatch the message to the target encoder.

Specified by:
applyToEncoder in class EncoderEvent

equals

public boolean equals(Object o)
Compare two events for equality.

Specified by:
equals in interface StepObject
Overrides:
equals in class Object
Throws:
ClassCastException - if the object is not an EncoderMessageEvent
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