1.0.9: GPL -> MIT, maven and javadoc supported

README.md

@@ -13,7 +13,38 @@ An Java 7 implementation of [TeamSpeak's 3 server query API](http://media.teamsp
 
 ## Getting Started
 
-First of all, you can always download the latest release [here](../../releases/latest) and add it to the buildpath of your project. Or you can also just download the sourcecode and put it in your project's source folder.
+First of all, you can always download the latest release [here](../../releases/latest) and add it to the buildpath of your project. 
+
+Or if you prefer Maven you add the following to your pom.xml:
+
+```xml
+<project>	
+	...
+	<repositories>
+		...
+		<repository>
+			<id>TeamSpeak-3-Java-API-mvn-repo</id>
+			<url>https://raw.githubusercontent.com/TheHolyWaffle/TeamSpeak-3-Java-API/mvn-repo/</url>
+			<snapshots>
+				<enabled>true</enabled>
+				<updatePolicy>always</updatePolicy>
+			</snapshots>
+		</repository>
+		...
+	</repositories>
+
+	<dependencies>
+		...
+		<dependency>
+			<groupId>com.github.theholywaffle</groupId>
+			<artifactId>teamspeak3-api</artifactId>
+			<version>[1.0.0,2.0.0)</version>
+		</dependency>
+		...
+	</dependencies>
+	...
+</project>
+```
 
 All functionality is contained in the [TS3Api](src/main/java/com/github/theholywaffle/teamspeak3/TS3Api.java) object.
 
@@ -42,7 +73,13 @@ api.sendChannelMessage("PutPutBot is online!");
 ...
 ```
 
-More examples can be found [here](src/main/java/com/github/theholywaffle/teamspeak3/example).
+**More examples:**
+
+[look here](example)
+
+**Latest Javadocs:**
+
+[look here](http://theholywaffle.github.io/TeamSpeak-3-Java-API/latest/)
 
 **Important:**
 

src/main/java/com/github/theholywaffle/teamspeak3/example/ChatBotExample.java → example/ChatBotExample.java

@@ -1,14 +1,28 @@
-/*******************************************************************************
- * Copyright (c) 2014 Bert De Geyter (https://github.com/TheHolyWaffle).
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the GNU Public License v3.0
- * which accompanies this distribution, and is available at
- * http://www.gnu.org/licenses/gpl.html
+/*
+ * #%L
+ * TeamSpeak 3 Java API
+ * %%
+ * Copyright (C) 2014 Bert De Geyter
+ * %%
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
  * 
- * Contributors:
- *     Bert De Geyter (https://github.com/TheHolyWaffle)
- ******************************************************************************/
-package com.github.theholywaffle.teamspeak3.example;
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ * #L%
+ */
 
 import java.util.logging.Level;
 
@@ -26,7 +40,7 @@
 import com.github.theholywaffle.teamspeak3.api.event.TextMessageEvent;
 
 public class ChatBotExample {
-	
+
 	public static void main(String[] args) {
 		new ChatBotExample();
 	}
@@ -36,55 +50,58 @@ public ChatBotExample() {
 		config.setHost("77.77.77.77");
 		config.setDebugLevel(Level.ALL);
 		config.setLoginCredentials("serveradmin", "serveradminpassword");
-		
+
 		final TS3Query query = new TS3Query(config);
 		query.connect();
-		
+
 		final TS3Api api = query.getApi();
 		api.selectVirtualServerById(1);
 		api.setNickname("PutPutBot");
 		api.sendChannelMessage("PutPutBot is online!");
-		
+
 		api.registerAllEvents();
 		api.addTS3Listeners(new TS3Listener() {
-			
+
 			public void onTextMessage(TextMessageEvent e) {
-				if(e.getTargetMode()== TextMessageTargetMode.CHANNEL){//Only react to channel messages
-					if(e.getMessage().equals("!ping")){
+				if (e.getTargetMode() == TextMessageTargetMode.CHANNEL) {// Only
+																			// react
+																			// to
+																			// channel
+																			// messages
+					if (e.getMessage().equals("!ping")) {
 						api.sendChannelMessage("pong");
 					}
-					if(e.getMessage().toLowerCase().contains("hello")){
-						api.sendChannelMessage("Hello "+e.getInvokerName());
+					if (e.getMessage().toLowerCase().contains("hello")) {
+						api.sendChannelMessage("Hello " + e.getInvokerName());
 					}
 				}
 			}
-			
+
 			public void onServerEdit(ServerEditedEvent e) {
-								
+
 			}
-			
+
 			public void onClientMoved(ClientMovedEvent e) {
-								
+
 			}
-			
+
 			public void onClientLeave(ClientLeaveEvent e) {
-								
+
 			}
-			
+
 			public void onClientJoin(ClientJoinEvent e) {
-								
+
 			}
-			
+
 			public void onChannelEdit(ChannelEditedEvent e) {
-								
+
 			}
-
-			public void onChannelDescriptionChanged(ChannelDescriptionEditedEvent e) {
-
+
+			public void onChannelDescriptionChanged(
+					ChannelDescriptionEditedEvent e) {
+
 			}
 		});
 	}
 
-
-
 }

example/ClientInfoExample.java

@@ -0,0 +1,60 @@
+/*
+ * #%L
+ * TeamSpeak 3 Java API
+ * %%
+ * Copyright (C) 2014 Bert De Geyter
+ * %%
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ * #L%
+ */
+
+import java.util.logging.Level;
+
+import com.github.theholywaffle.teamspeak3.TS3Api;
+import com.github.theholywaffle.teamspeak3.TS3Config;
+import com.github.theholywaffle.teamspeak3.TS3Query;
+import com.github.theholywaffle.teamspeak3.api.wrapper.Client;
+
+public class ClientInfoExample {
+
+	public static void main(String[] args) {
+		new ClientInfoExample();
+	}
+
+	public ClientInfoExample() {
+		final TS3Config config = new TS3Config();
+		config.setHost("77.77.77.77");
+		config.setDebugLevel(Level.ALL);
+		config.setLoginCredentials("serveradmin", "serveradminpassword");
+
+		final TS3Query query = new TS3Query(config);
+		query.connect();
+
+		final TS3Api api = query.getApi();
+		api.selectVirtualServerById(1);
+		api.setNickname("PutPutBot");
+		api.sendChannelMessage("PutPutBot is online!");
+
+		for (final Client c : api.getClients()) {
+			System.out.println(c.getNickname() + " in channel: "
+					+ api.getChannelInfo(c.getChannelId()).getName());
+		}
+	}
+
+}

example/CreateChannelExample.java

@@ -0,0 +1,66 @@
+/*
+ * #%L
+ * TeamSpeak 3 Java API
+ * %%
+ * Copyright (C) 2014 Bert De Geyter
+ * %%
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ * #L%
+ */
+
+import java.util.HashMap;
+import java.util.logging.Level;
+
+import com.github.theholywaffle.teamspeak3.TS3Api;
+import com.github.theholywaffle.teamspeak3.TS3Config;
+import com.github.theholywaffle.teamspeak3.TS3Query;
+import com.github.theholywaffle.teamspeak3.api.ChannelProperty;
+
+public class CreateChannelExample {
+
+	public static void main(String[] args) {
+		new ChatBotExample();
+	}
+
+	public CreateChannelExample() {
+		final TS3Config config = new TS3Config();
+		config.setHost("77.77.77.77");
+		config.setDebugLevel(Level.ALL);
+		config.setLoginCredentials("serveradmin", "serveradminpassword");
+
+		final TS3Query query = new TS3Query(config);
+		query.connect();
+
+		final TS3Api api = query.getApi();
+		api.selectVirtualServerById(1);
+		api.setNickname("PutPutBot");
+		api.sendChannelMessage("PutPutBot is online!");
+
+		final HashMap<ChannelProperty, String> properties = new HashMap<>();
+		properties.put(ChannelProperty.CHANNEL_FLAG_PERMANENT, "1"); // Make
+																		// channel
+																		// permanent
+		properties.put(ChannelProperty.CPID, "3"); // Make it a subchannel of
+													// channel 3
+
+		api.createChannel("New Channel", properties); // Create the channel with
+														// our properties :)
+	}
+
+}

src/main/java/com/github/theholywaffle/teamspeak3/example/EventListenerExample.java → example/EventListenerExample.java

@@ -1,14 +1,28 @@
-/*******************************************************************************
- * Copyright (c) 2014 Bert De Geyter (https://github.com/TheHolyWaffle).
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the GNU Public License v3.0
- * which accompanies this distribution, and is available at
- * http://www.gnu.org/licenses/gpl.html
+/*
+ * #%L
+ * TeamSpeak 3 Java API
+ * %%
+ * Copyright (C) 2014 Bert De Geyter
+ * %%
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
  * 
- * Contributors:
- *     Bert De Geyter (https://github.com/TheHolyWaffle)
- ******************************************************************************/
-package com.github.theholywaffle.teamspeak3.example;
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ * #L%
+ */
 
 import java.util.logging.Level;
 
@@ -25,7 +39,7 @@
 import com.github.theholywaffle.teamspeak3.api.event.TextMessageEvent;
 
 public class EventListenerExample {
-	
+
 	public static void main(String[] args) {
 		new EventListenerExample();
 	}
@@ -35,10 +49,10 @@ public EventListenerExample() {
 		config.setHost("77.77.77.77");
 		config.setDebugLevel(Level.ALL);
 		config.setLoginCredentials("serveradmin", "serveradminpassword");
-		
+
 		final TS3Query query = new TS3Query(config);
 		query.connect();
-		
+
 		final TS3Api api = query.getApi();
 		api.selectVirtualServerById(1);
 		api.setNickname("PutPutBot");
@@ -82,7 +96,6 @@ public void onChannelDescriptionChanged(
 			}
 		});
 
-
-	}	
+	}
 
 }