com.github.agogs.holidayapi.model

Class QueryParams

java.lang.Object

com.github.agogs.holidayapi.model.QueryParams

public class QueryParams
extends Object

This class is used to encapsulate the query parameters for the API call. The methods can be chained together for easier and readable coding This class also provides the following enums which is associated with the parameter values.

• QueryParams.APIParameter - enumeration of keys for allowed parameters
• QueryParams.Country - enumeration of allowed country codes for the parameter QueryParams.APIParameter.COUNTRY
• QueryParams.Format - enumeration of available response formats

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueryParams.APIParameter Enumeration of allowed query parameters
static class	QueryParams.Country Enumeration of allowed country codes for the parameter QueryParams.APIParameter.COUNTRY
static class	QueryParams.Format Enumeration for allowed values for the query parameter QueryParams.APIParameter.FORMAT

Constructor Summary

Constructors

Constructor and Description
QueryParams()

Method Summary

Modifier and Type	Method and Description
QueryParams	country(QueryParams.Country country)
QueryParams	day(int day)
QueryParams	format(QueryParams.Format format)
QueryParams	isPublic(boolean isPublic)
QueryParams	key(String key)
QueryParams	month(int month)
QueryParams	pretty(boolean pretty)
QueryParams	previous(boolean previous)
String	queryString() Return the query string
String	toString()
QueryParams	upcoming(boolean upcoming)
QueryParams	year(int year)

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryParams

public QueryParams()

Method Detail

key

public QueryParams key(String key)

country

public QueryParams country(QueryParams.Country country)

year

public QueryParams year(int year)

month

public QueryParams month(int month)

day

public QueryParams day(int day)

previous

public QueryParams previous(boolean previous)

upcoming

public QueryParams upcoming(boolean upcoming)

isPublic

public QueryParams isPublic(boolean isPublic)

format

public QueryParams format(QueryParams.Format format)

pretty

public QueryParams pretty(boolean pretty)

queryString

public String queryString()

Return the query string

Returns:

- return the query string

toString

public String toString()

Overrides:

toString in class Object