Class Start

java.lang.Object
edu.uky.cs.nil.tt.io.Message
edu.uky.cs.nil.tt.io.Start
public class Start extends Message
The start message is sent from the {edu.uky.cs.nil.tt.Server server} to an agent when a partner has been found and their session begins.
Author:
Stephen G. Ware

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    final Role
    role
    The role the recipient of this message will have in the session
    final World
    world
    The story world in which the session will take place

  • Constructor Summary

    Constructors
    Constructor
    Description
    Start(World world, Role role)
    Constructs a new start message with the given story world the session will take place in.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    toString()
     
    void
    verify()
    Checks that this message is correctly configured and throws an exception if not.

    Methods inherited from class Message

    configure, getAgent, setAgent

    Methods inherited from class Object

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

  • Field Details

    • world

      public final World world
      The story world in which the session will take place

    • role

      public final Role role
      The role the recipient of this message will have in the session

  • Constructor Details

    • Start

      public Start(World world, Role role)
      Constructs a new start message with the given story world the session will take place in.
      Parameters:
      world - the story world the session will take place in
      role - the role the recipient of this message will play in the session

  • Method Details

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • verify

      public void verify()
      Description copied from class: Message
      Checks that this message is correctly configured and throws an exception if not. This method should be called soon after the message has been parsed. It should check that all the necessary fields are set and that their values are legal values.
      Specified by:
      verify in class Message