com.omertron.themoviedbapi.tools

Enum Param

java.lang.Object

java.lang.Enum<Param>

com.omertron.themoviedbapi.tools.Param

All Implemented Interfaces:

Serializable, Comparable<Param>

public enum Param
extends Enum<Param>

Parameters for use in the URL

Author:

Stuart

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADULT
API_KEY
APPEND
CERTIFICATION
CERTIFICATION_COUNTRY
CERTIFICATION_LTE
CONFIRM
COUNTRY
END_DATE
EPISODE_NUMBER
EXTERNAL_SOURCE
FAVORITE
FIRST_AIR_DATE_GTE
FIRST_AIR_DATE_LTE
FIRST_AIR_DATE_YEAR
GUEST_SESSION_ID
ID
INCLUDE_ADULT
INCLUDE_ALL_MOVIES
INCLUDE_IMAGE_LANGUAGE
INCLUDE_VIDEO
LANGUAGE
MOVIE_ID
MOVIE_WATCHLIST
PAGE
PASSWORD
PRIMARY_RELEASE_YEAR
QUERY
RELEASE_DATE_GTE
RELEASE_DATE_LTE
SEARCH_TYPE
SEASON_NUMBER
SESSION_ID
SORT_BY
SORT_ORDER
START_DATE
TIMEZONE
TOKEN
USERNAME
VALUE
VOTE_AVERAGE_GTE
VOTE_AVERAGE_LTE
VOTE_COUNT_GTE
VOTE_COUNT_LTE
WITH_CAST
WITH_COMPANIES
WITH_CREW
WITH_GENRES
WITH_KEYWORDS
WITH_NETWORKS
WITH_PEOPLE
YEAR

Method Summary

Modifier and Type	Method and Description
static Param	fromString(String value) Convert a string into an Enum type
String	getValue() Get the URL parameter to use
static Param	valueOf(String name) Returns the enum constant of this type with the specified name.
static Param[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ADULT

public static final Param ADULT

API_KEY

public static final Param API_KEY

APPEND

public static final Param APPEND

CERTIFICATION

public static final Param CERTIFICATION

CERTIFICATION_COUNTRY

public static final Param CERTIFICATION_COUNTRY

CERTIFICATION_LTE

public static final Param CERTIFICATION_LTE

CONFIRM

public static final Param CONFIRM

COUNTRY

public static final Param COUNTRY

END_DATE

public static final Param END_DATE

EPISODE_NUMBER

public static final Param EPISODE_NUMBER

EXTERNAL_SOURCE

public static final Param EXTERNAL_SOURCE

FAVORITE

public static final Param FAVORITE

FIRST_AIR_DATE_GTE

public static final Param FIRST_AIR_DATE_GTE

FIRST_AIR_DATE_LTE

public static final Param FIRST_AIR_DATE_LTE

FIRST_AIR_DATE_YEAR

public static final Param FIRST_AIR_DATE_YEAR

GUEST_SESSION_ID

public static final Param GUEST_SESSION_ID

ID

public static final Param ID

INCLUDE_ADULT

public static final Param INCLUDE_ADULT

INCLUDE_ALL_MOVIES

public static final Param INCLUDE_ALL_MOVIES

INCLUDE_IMAGE_LANGUAGE

public static final Param INCLUDE_IMAGE_LANGUAGE

INCLUDE_VIDEO

public static final Param INCLUDE_VIDEO

LANGUAGE

public static final Param LANGUAGE

MOVIE_ID

public static final Param MOVIE_ID

MOVIE_WATCHLIST

public static final Param MOVIE_WATCHLIST

PAGE

public static final Param PAGE

PASSWORD

public static final Param PASSWORD

PRIMARY_RELEASE_YEAR

public static final Param PRIMARY_RELEASE_YEAR

QUERY

public static final Param QUERY

RELEASE_DATE_GTE

public static final Param RELEASE_DATE_GTE

RELEASE_DATE_LTE

public static final Param RELEASE_DATE_LTE

SEARCH_TYPE

public static final Param SEARCH_TYPE

SEASON_NUMBER

public static final Param SEASON_NUMBER

SESSION_ID

public static final Param SESSION_ID

SORT_BY

public static final Param SORT_BY

SORT_ORDER

public static final Param SORT_ORDER

START_DATE

public static final Param START_DATE

TIMEZONE

public static final Param TIMEZONE

TOKEN

public static final Param TOKEN

USERNAME

public static final Param USERNAME

VALUE

public static final Param VALUE

VOTE_AVERAGE_GTE

public static final Param VOTE_AVERAGE_GTE

VOTE_AVERAGE_LTE

public static final Param VOTE_AVERAGE_LTE

VOTE_COUNT_GTE

public static final Param VOTE_COUNT_GTE

VOTE_COUNT_LTE

public static final Param VOTE_COUNT_LTE

WITH_CAST

public static final Param WITH_CAST

WITH_COMPANIES

public static final Param WITH_COMPANIES

WITH_CREW

public static final Param WITH_CREW

WITH_GENRES

public static final Param WITH_GENRES

WITH_KEYWORDS

public static final Param WITH_KEYWORDS

WITH_NETWORKS

public static final Param WITH_NETWORKS

WITH_PEOPLE

public static final Param WITH_PEOPLE

YEAR

public static final Param YEAR

Method Detail

values

public static Param[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Param c : Param.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Param valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public String getValue()

Get the URL parameter to use

Returns:

value

fromString

public static Param fromString(String value)

Convert a string into an Enum type

Parameters:

value - the string representation of the enum

Returns:

matching enum