View Javadoc

1   /*
2      Copyright 2010 Ramon Servadei
3   
4      Licensed under the Apache License, Version 2.0 (the "License");
5      you may not use this file except in compliance with the License.
6      You may obtain a copy of the License at
7   
8          http://www.apache.org/licenses/LICENSE-2.0
9   
10     Unless required by applicable law or agreed to in writing, software
11     distributed under the License is distributed on an "AS IS" BASIS,
12     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13     See the License for the specific language governing permissions and
14     limitations under the License.
15   */
16  package mirrormap.commands;
17  
18  import java.io.Serializable;
19  
20  import mirrormap.MirrorMap;
21  
22  /**
23   * Represents an command to perform on a {@link MirrorMap}
24   * 
25   * @author Ramon Servadei
26   */
27  public interface ICommand extends Serializable
28  {
29      /**
30       * The {@link MirrorMap} the command is for
31       * 
32       * @return the name of the {@link MirrorMap} the command is targetted at
33       */
34      String getMirrorMapName();
35  
36      /**
37       * Execute the command
38       */
39      void execute();
40  
41      /**
42       * Get the serialised <code>byte[]</code> of this
43       * 
44       * @return the serialised <code>byte[]</code> of this
45       */
46      byte[] getBytes();
47  }