/*
      IMPORTANT !!!
   
      DO NOT EDIT THIS FILE. IT IS GENERATED FROM APPROPRIATE XML FILE
      BY THE MessagesGenerator.xslt.
      MODIFY THAT FILE INSTEAD OF THIS ONE.
   
    */
   package cz.cuni.amis.pogamut.defcon.communication.messages.commands;
  
  import cz.cuni.amis.pogamut.base.communication.messages.*;
  import cz.cuni.amis.pogamut.base.communication.worldview.*;
  import cz.cuni.amis.pogamut.base.communication.worldview.object.*;
  import cz.cuni.amis.pogamut.defcon.base3d.worldview.object.DefConLocation;
  import cz.cuni.amis.pogamut.defcon.communication.messages.*;
  import cz.cuni.amis.pogamut.defcon.communication.messages.commands.*;
  import cz.cuni.amis.pogamut.defcon.communication.messages.infos.*;
  import cz.cuni.amis.pogamut.defcon.consts.*;
  import cz.cuni.amis.pogamut.defcon.consts.state.*;
  import cz.cuni.amis.utils.exception.*;
  
  import java.util.*;
  
  import javabot.*;
  
  
  /**
   * Sends the message down to the specified chat channel inside the DefCon.
   */
  public class SendChatMessage extends DefConCommand {
      /**
       * Message to send.
       */
      private String message = null;
  
      /**
       * Chat channel to use.
       */
      private ChatChannel channel = ChatChannel.PUBLIC;
  
  /**
                       * Creates new instance of command SendChatMessage.
                            
                  Sends the message down to the specified chat channel inside the DefCon. 
          
                       @param
                        message Message to send.
                       @param
                        channel Chat channel to use.
                   */
      public SendChatMessage(String message, ChatChannel channel) {
          this.message = message;
  
          this.channel = channel;
      }
  
  /**
                           * Cloning constructor...
                           * @param original
                           */
      public SendChatMessage(SendChatMessage original) {
          this.message = original.message;
  
          this.channel = original.channel;
      }
  
      /**
       * Message to send.
       *
       * @return String
       */
      public String getMessage() {
          return this.message;
      }
  
      /**
       * Message to send.
       *
       * @param message
       *
       * @return this object, allows you to chain setters
       */
      public SendChatMessage setMessage(String message) {
          this.message = message;
  
          return this;
      }
  
      /**
       * Chat channel to use.
       *
       * @return ChatChannel
       */
      public ChatChannel getChannel() {
          return this.channel;
      }
  
      /**
       * Chat channel to use.
      *
      * @param channel
      *
      * @return this object, allows you to chain setters
      */
     public SendChatMessage setChannel(ChatChannel channel) {
         this.channel = channel;
 
         return this;
     }
 
     /**
      * Performs the command - to be used only by the {@link DefConCommandExecutor}.
      */
     @Override
     public void perform() {
         JBot.SendChatMessage(getMessage(), getChannel().id);
     }
 
     /**
      * Returns human readable serialization of the message.
      *
      * @return human readable string
      */
     @Override
     public String toString() {
         return "SendChatMessage[" + getStringizedFields() + "; Message = " + this.message +
         "; Channel = " + this.channel + "]";
     }
 
     /**
      * Returns message in html format.
      *
      * @return html message
      */
     public String toHtmlString() {
         return "<p><b>SendChatMessage:</b></p>" + "<p><i>Message:</i> " + this.message + "</p>" +
         "<p><i>Channel:</i> " + this.channel + "</p>";
     }
 }