com.github.theholywaffle.teamspeak3.api.wrapper

Class Wrapper

java.lang.Object

com.github.theholywaffle.teamspeak3.api.wrapper.Wrapper

Direct Known Subclasses:

AdvancedPermission, Ban, BaseEvent, Binding, ChannelBase, ChannelGroup, ChannelGroupClient, Client, Complaint, ConnectionInfo, CreatedVirtualServer, DatabaseClient, HostInfo, InstanceInfo, Message, Permission, PermissionInfo, PrivilegeKey, QueryError, ServerGroup, ServerGroupClient, ServerQueryInfo, Version, VirtualServer

public class Wrapper
extends Object

A wrapper class around a Map.

We use wrapper classes instead of just passing around plain Maps because

• it's more descriptive
• there's no confusion between types (e.g. Client and Channel)
• we can create getters for the specific use-cases
• we don't have to check for null each time

Constructor Summary

Constructors

Constructor and Description
Wrapper(Map<String,String> map) Creates a new wrapper around the given map.

Method Summary

Modifier and Type	Method and Description
String	get(Property property) Gets a property as a String from the underlying map.
String	get(String propertyName) Gets a property as a String from the underlying map.
boolean	getBoolean(Property property) Gets a property as a boolean from the underlying map.
boolean	getBoolean(String propertyName) Gets a property as a boolean from the underlying map.
double	getDouble(Property property) Gets a property as a double from the underlying map.
double	getDouble(String propertyName) Gets a property as a double from the underlying map.
int	getInt(Property property) Gets a property as an integer from the underlying map.
int	getInt(String propertyName) Gets a property as an integer from the underlying map.
long	getLong(Property property) Gets a property as a long from the underlying map.
long	getLong(String propertyName) Gets a property as a long from the underlying map.
Map<String,String>	getMap() Gets the map underlying this Wrapper.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Wrapper

public Wrapper(Map<String,String> map)

Creates a new wrapper around the given map.

Parameters:

map - the Map to abstract, cannot be null

Method Detail

getMap

public Map<String,String> getMap()

Gets the map underlying this Wrapper.

Returns:

the underlying map

getBoolean

public boolean getBoolean(String propertyName)

Gets a property as a boolean from the underlying map. Returns true if the property exists in the map and its value is "1".

Parameters:

propertyName - the name of the property

Returns:

the boolean value of the property or false if the property doesn't exist

getBoolean

public boolean getBoolean(Property property)

Gets a property as a boolean from the underlying map. Returns true if the property exists in the map and its value is "1".

Parameters:

property - the property

Returns:

the boolean value of the property or false if the property doesn't exist

getDouble

public double getDouble(String propertyName)

Gets a property as a double from the underlying map. If the property doesn't exist in the underlying map, -1.0 is returned.

Parameters:

propertyName - the name of the property

Returns:

the double value of the property or -1.0 if the property doesn't exist

getDouble

public double getDouble(Property property)

Gets a property as a double from the underlying map. If the property doesn't exist in the underlying map, -1.0 is returned.

Parameters:

property - the property

Returns:

the double value of the property or -1.0 if the property doesn't exist

getLong

public long getLong(String propertyName)

Gets a property as a long from the underlying map. If the property doesn't exist in the underlying map, -1 is returned.

Parameters:

propertyName - the name of the property

Returns:

the long value of the property or -1 if the property doesn't exist

getLong

public long getLong(Property property)

Gets a property as a long from the underlying map. If the property doesn't exist in the underlying map, -1 is returned.

Parameters:

property - the property

Returns:

the long value of the property or -1 if the property doesn't exist

getInt

public int getInt(String propertyName)

Gets a property as an integer from the underlying map. If the property doesn't exist in the underlying map, -1 is returned.

Parameters:

propertyName - the name of the property

Returns:

the integer value of the property or -1 if the property doesn't exist

getInt

public int getInt(Property property)

Gets a property as an integer from the underlying map. If the property doesn't exist in the underlying map, -1 is returned.

Parameters:

property - the property

Returns:

the integer value of the property or -1 if the property doesn't exist

get

public String get(String propertyName)

Gets a property as a String from the underlying map. If the property doesn't exist in the underlying map, an empty String is returned.

Parameters:

propertyName - the name of the property

Returns:

the String value of the property or an empty String if the property doesn't exist

get

public String get(Property property)

Gets a property as a String from the underlying map. If the property doesn't exist in the underlying map, an empty String is returned.

Parameters:

property - the property

Returns:

the String value of the property or an empty String if the property doesn't exist

toString

public String toString()

Overrides:

toString in class Object