com.omertron.themoviedbapi.tools

Class TmdbParameters

java.lang.Object

com.omertron.themoviedbapi.tools.TmdbParameters

public class TmdbParameters
extends Object

Parameters for the TMDB API

Author:

Stuart

Constructor Summary

Constructors

Constructor and Description
TmdbParameters() Construct an empty set of parameters

Method Summary

Modifier and Type	Method and Description
void	add(Param key, Boolean value) Add a boolean parameter to the collection
void	add(Param key, Float value) Add a float parameter to the collection
void	add(Param key, Integer value) Add an integer parameter to the collection
void	add(Param key, String value) Add a string parameter to the collection
void	add(Param key, String[] value) Add an array parameter to the collection
Object	get(Param key) Get a parameter from the collection
Set<Map.Entry<Param,String>>	getEntries() Get the entry set of the parameters
boolean	has(Param key) Check to see if the collection has a certain parameter
boolean	isEmpty() Check to see if the collection has no items
boolean	isNotEmpty() Check to see if the collection has items
void	remove(Param key) Remove a parameter from the collection
String	toList(String[] appendToResponse) Append any optional parameters to the URL
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TmdbParameters

public TmdbParameters()

Construct an empty set of parameters

Method Detail

getEntries

public Set<Map.Entry<Param,String>> getEntries()

Get the entry set of the parameters

Returns:

map of parameters

add

public void add(Param key,
                String[] value)

Add an array parameter to the collection

Parameters:

key - Parameter to add

value - The array value to use (will be converted into a comma separated list)

add

public void add(Param key,
                String value)

Add a string parameter to the collection

Parameters:

key - Parameter to add

value - The value to add (will be checked to ensure it's valid)

add

public void add(Param key,
                Integer value)

Add an integer parameter to the collection

Parameters:

key - Parameter to add

value - The value to add (will be checked to ensure greater than zero)

add

public void add(Param key,
                Float value)

Add a float parameter to the collection

Parameters:

key - Parameter to add

value - The value to add (will be checked to ensure greater than zero)

add

public void add(Param key,
                Boolean value)

Add a boolean parameter to the collection

Parameters:

key - Parameter to add

value - The value to add (will be checked to ensure greater than zero)

has

public boolean has(Param key)

Check to see if the collection has a certain parameter

Parameters:

key - The Parameter to check

Returns:

true if parameter exists

get

public Object get(Param key)

Get a parameter from the collection

Parameters:

key - The parameter to get

Returns:

the parameter

remove

public void remove(Param key)

Remove a parameter from the collection

Parameters:

key - parameter to remove

isEmpty

public boolean isEmpty()

Check to see if the collection has no items

Returns:

true if the parameters are empty

isNotEmpty

public boolean isNotEmpty()

Check to see if the collection has items

Returns:

true if there are parameters

toList

public String toList(String[] appendToResponse)

Append any optional parameters to the URL

Parameters:

appendToResponse - String array to convert to a comma list

Returns:

comma separated list

toString

public String toString()

Overrides:

toString in class Object