View Javadoc

1   /*
2      IMPORTANT !!!
3   
4      DO NOT EDIT THIS FILE. IT IS GENERATED FROM APPROPRIATE XML FILE
5      BY THE MessagesGenerator.xslt.
6      MODIFY THAT FILE INSTEAD OF THIS ONE.
7   
8    */
9   package cz.cuni.amis.pogamut.defcon.communication.messages.commands;
10  
11  import cz.cuni.amis.pogamut.base.communication.messages.*;
12  import cz.cuni.amis.pogamut.base.communication.worldview.*;
13  import cz.cuni.amis.pogamut.base.communication.worldview.object.*;
14  import cz.cuni.amis.pogamut.defcon.base3d.worldview.object.DefConLocation;
15  import cz.cuni.amis.pogamut.defcon.communication.messages.*;
16  import cz.cuni.amis.pogamut.defcon.communication.messages.commands.*;
17  import cz.cuni.amis.pogamut.defcon.communication.messages.infos.*;
18  import cz.cuni.amis.pogamut.defcon.consts.*;
19  import cz.cuni.amis.pogamut.defcon.consts.state.*;
20  import cz.cuni.amis.utils.exception.*;
21  
22  import java.util.*;
23  
24  import javabot.*;
25  
26  
27  /**
28   * Votes in a poll.
29   */
30  public class SendVote extends DefConCommand {
31      /**
32       * Type of vote.
33       */
34      private VoteType voteType = null;
35  
36      /**
37       * Type of vote.
38       */
39      private Vote vote = null;
40  
41  /**
42                       * Creates new instance of command SendVote.
43                            
44                  Votes in a poll. 
45          
46                       @param
47                        voteType Type of vote.
48                       @param
49                        vote Type of vote.
50                   */
51      public SendVote(VoteType voteType, Vote vote) {
52          this.voteType = voteType;
53  
54          this.vote = vote;
55      }
56  
57  /**
58                           * Cloning constructor...
59                           * @param original
60                           */
61      public SendVote(SendVote original) {
62          this.voteType = original.voteType;
63  
64          this.vote = original.vote;
65      }
66  
67      /**
68       * Type of vote.
69       *
70       * @return VoteType
71       */
72      public VoteType getVoteType() {
73          return this.voteType;
74      }
75  
76      /**
77       * Type of vote.
78       *
79       * @param voteType
80       *
81       * @return this object, allows you to chain setters
82       */
83      public SendVote setVoteType(VoteType voteType) {
84          this.voteType = voteType;
85  
86          return this;
87      }
88  
89      /**
90       * Type of vote.
91       *
92       * @return Vote
93       */
94      public Vote getVote() {
95          return this.vote;
96      }
97  
98      /**
99       * Type of vote.
100      *
101      * @param vote
102      *
103      * @return this object, allows you to chain setters
104      */
105     public SendVote setVote(Vote vote) {
106         this.vote = vote;
107 
108         return this;
109     }
110 
111     /**
112      * Performs the command - to be used only by the {@link DefConCommandExecutor}.
113      */
114     @Override
115     public void perform() {
116         JBot.SendVote(getVoteType().id, getVote().id);
117     }
118 
119     /**
120      * Returns human readable serialization of the message.
121      *
122      * @return human readable string
123      */
124     @Override
125     public String toString() {
126         return "SendVote[" + getStringizedFields() + "; VoteType = " + this.voteType + "; Vote = " +
127         this.vote + "]";
128     }
129 
130     /**
131      * Returns message in html format.
132      *
133      * @return html message
134      */
135     public String toHtmlString() {
136         return "<p><b>SendVote:</b></p>" + "<p><i>VoteType:</i> " + this.voteType + "</p>" +
137         "<p><i>Vote:</i> " + this.vote + "</p>";
138     }
139 }