Message

java.lang.Object
- stella.net.gregor.Message

Direct Known Subclasses:

CommandMessage
```
public class Message
extends Object
```
This class represents a GREGOR message (GRE-KIS-NOT-0013.pdf)

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Message.GregorDesignation` This interface defines special conversion of source objects to 16-char long strings in the message fields.

Field Summary

Fields
Modifier and Type	Field and Description
`private byte[]`	`data` The data of the message.
`private String`	`dest` Destination of this message.
`private short`	`flags` The flag field consits of thw bytes, represented as a short.
`static short`	`GREC` Grec bit in flags.
`private int`	`id` Each message has a unique serial number, represented as an int.
`private static int`	`ID` The current value.
`static short`	`PACE` PacE bit in flags.
`static short`	`RPLY` RPLY bit in flags.
`private String`	`src` The source of this message.
`static short`	`URG` URG bit in flags.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`Message(Object src, Object dest)` Creates a message, specifying src and destination.
	`Message(Object src, Object dest, byte[] ascii)` Creates amessage with source, destination and data section.
	`Message(Object src, Object dest, byte[] ascii, short fl)` Creates amessage with source, destination, data section and flags.
`protected`	`Message(Object src, Object dest, byte[] ascii, short fl, int i)` Full constructor, hidden from the outside.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addFlag(short mask)` Adds one of the defined flags to the current flag setting.
`byte[]`	`getData()` Returns the data of this message.
`int`	`getDataLength()` Returns the data length of this message.
`String`	`getDestination()` Returns the message destination as a 16-byte long string.
`short`	`getFlags()` Returns the data flags.
`int`	`getID()` Returns the serial ID of this message.
`protected static int`	`getNextId()` Returns the next id readily as an integer.
`String`	`getPayload()` Returns the data part of the message or the empty string if no data is carried.
`String`	`getSource()` Returns the message source as a 16-byte long string.
`static String`	`getString16(Object o)` If the object implements GregorDesignation, we convert it according to this interface, otherwise the toString method is used.
`int`	`hashCode()` Returns the unique ID as the hash.
`boolean`	`isGrec()` Test the message for grec-interpretation.
`boolean`	`isPace()` Test the message for pace-interpretation
`boolean`	`isReply()` Test the message for urgency.
`boolean`	`isUrgent()` Test the message for urgency.
`void`	`setData(byte[] ascii)` Sets the data of this message.
`void`	`setFlags(short fl)` Updates the flags.
`protected void`	`setID(int i)` Sets the unique ID of this message.
`protected boolean`	`testFlags(short mask)` Test a bit mask.
`String`	`toString()` Returns a descriptive string of this message including field declarations.
`String`	`toString(boolean multiline)` Returns a descriptive string of this message including field declarations.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - PACE
```
public static final short PACE
```
    PacE bit in flags.
    
    See Also:
    
    Constant Field Values
  - GREC
```
public static final short GREC
```
    Grec bit in flags.
    
    See Also:
    
    Constant Field Values
  - URG
```
public static final short URG
```
    URG bit in flags.
    
    See Also:
    
    Constant Field Values
  - RPLY
```
public static final short RPLY
```
    RPLY bit in flags.
    
    See Also:
    
    Constant Field Values
  - flags
```
private short flags
```
    The flag field consits of thw bytes, represented as a short.
  - id
```
private int id
```
    Each message has a unique serial number, represented as an int.
  - src
```
private String src
```
    The source of this message. maximum 16 bytes.
  - dest
```
private String dest
```
    Destination of this message. Maximum 16 bytes.
  - data
```
private byte[] data
```
    The data of the message. In the easiest case a string as a byte array.
  - ID
```
private static int ID
```
    The current value.
- Constructor Detail
  - Message
```
public Message(Object src,
               Object dest)
```
    Creates a message, specifying src and destination.
  - Message
```
public Message(Object src,
               Object dest,
               byte[] ascii)
```
    Creates amessage with source, destination and data section. Flags are defaulted to zero, the serial id is auto-generated.
  - Message
```
public Message(Object src,
               Object dest,
               byte[] ascii,
               short fl)
```
    Creates amessage with source, destination, data section and flags. The serial id is auto-generated.
  - Message
```
protected Message(Object src,
                  Object dest,
                  byte[] ascii,
                  short fl,
                  int i)
```
    Full constructor, hidden from the outside.
- Method Detail
  - getNextId
```
protected static int getNextId()
```
    Returns the next id readily as an integer.
  - hashCode
```
public int hashCode()
```
    Returns the unique ID as the hash.
    
    Overrides:
    
    hashCode in class Object
  - getSource
```
public String getSource()
```
    Returns the message source as a 16-byte long string.
  - getDestination
```
public String getDestination()
```
    Returns the message destination as a 16-byte long string.
  - setData
```
public void setData(byte[] ascii)
```
    Sets the data of this message.
  - getData
```
public byte[] getData()
```
    Returns the data of this message.
  - getDataLength
```
public int getDataLength()
```
    Returns the data length of this message.
  - setFlags
```
public void setFlags(short fl)
```
    Updates the flags.
  - addFlag
```
public void addFlag(short mask)
```
    Adds one of the defined flags to the current flag setting.
  - getFlags
```
public short getFlags()
```
    Returns the data flags.
  - isUrgent
```
public boolean isUrgent()
```
    Test the message for urgency.
  - isPace
```
public boolean isPace()
```
    Test the message for pace-interpretation
  - isGrec
```
public boolean isGrec()
```
    Test the message for grec-interpretation.
  - isReply
```
public boolean isReply()
```
    Test the message for urgency.
  - getID
```
public int getID()
```
    Returns the serial ID of this message.
  - testFlags
```
protected boolean testFlags(short mask)
```
    Test a bit mask.
  - setID
```
protected void setID(int i)
```
    Sets the unique ID of this message. Not intended for normal use. If using this method, the caller must ensure the uniqueness of the id.
  - toString
```
public String toString()
```
    Returns a descriptive string of this message including field declarations.
    
    Overrides:
    
    toString in class Object
  - toString
```
public String toString(boolean multiline)
```
    Returns a descriptive string of this message including field declarations. If multiline is true, two lines separated by '\n' are returned.
  - getPayload
```
public String getPayload()
```
    Returns the data part of the message or the empty string if no data is carried.
  - getString16
```
public static String getString16(Object o)
```
    If the object implements GregorDesignation, we convert it according to this interface, otherwise the toString method is used. The resulting string is always right-padded with spaces to yield a 16-bye string.

Class Message

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PACE

GREC

URG

RPLY

flags

id

src

dest

data

ID

Constructor Detail

Message

Message

Message

Message

Method Detail

getNextId

hashCode

getSource

getDestination

setData

getData

getDataLength

setFlags

addFlag

getFlags

isUrgent

isPace

isGrec

isReply

getID

testFlags

setID

toString

toString

getPayload

getString16