View Javadoc

1   /**
2    * BaseUnrealEnvironment, an implementation of the environment interface standard that 
3    * facilitates the connection between GOAL and the UT2004 engine. 
4    * 
5    * Copyright (C) 2012 BaseUnrealEnvironment authors.
6    * 
7    * This program is free software: you can redistribute it and/or modify it under
8    * the terms of the GNU General Public License as published by the Free Software
9    * Foundation, either version 3 of the License, or (at your option) any later
10   * version.
11   * 
12   * This program is distributed in the hope that it will be useful, but WITHOUT
13   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
14   * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
15   * details.
16   * 
17   * You should have received a copy of the GNU General Public License along with
18   * this program. If not, see <http://www.gnu.org/licenses/>.
19   */
20  package nl.tudelft.goal.unreal.messages;
21  
22  import java.util.logging.Level;
23  
24  /**
25   * List of valid parameter keys that can be used to initialize the environment.
26   * 
27   * 
28   * @author M.P. Korstanje
29   * 
30   */
31  public enum ConfigurationKey implements Key {
32  
33  	/**
34  	 * List of bots
35  	 * 
36  	 */
37  	BOTS("bots"),
38  	/**
39  	 * Address of the server.
40  	 * 
41  	 * Should be of the form protocol//host:port
42  	 */
43  	BOT_SERVER("botServer"),
44  	/**
45  	 * Address of the server.
46  	 * 
47  	 * Should be of the form protocol//host:port
48  	 */
49  	CONTROL_SERVER("controlServer"),
50  
51  	/**
52  	 * Log level used. Controls how many messages are displayed on the console.
53  	 * 
54  	 * Valid log levels are any from {@link Level}.
55  	 */
56  	LOGLEVEL("logLevel"),
57  
58  	/**
59  	 * Address for the visualizer service.
60  	 * 
61  	 */
62  	VISUALIZER_SERVER("visualizer"), 
63  	
64  	/**
65  	 * Class of the bot controller
66  	 */
67  	BOT_CONTROLLER("class");
68  	
69  
70  
71  	// Human readable (camelCase) form of the enum.
72  	private String key;
73  
74  	private ConfigurationKey(String name) {
75  		this.key = name;
76  	}
77  
78  	@Override
79  	public String getKey() {
80  		
81  		return key;
82  	}
83  }