Package com.google.photos.library.v1.util

Enum OrderBy

java.lang.Object

java.lang.Enum<OrderBy>

com.google.photos.library.v1.util.OrderBy

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<OrderBy>

public enum OrderBy
extends java.lang.Enum<OrderBy>

Order of search results.

The value expected by the Library API can be retrieved from getRequestValue().

See Also:

PhotosLibraryClient.searchMediaItems(Filters, OrderBy...)

Enum Constant Summary

Enum Constants

Enum Constant	Description
MEDIAMETADATA_CREATION_TIME
MEDIAMETADATA_CREATION_TIME_DESC

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	SEPARATOR	Separator used to join multiple order configurations.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getRequestValue()	String representation of a sort option.
static OrderBy	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static OrderBy[]	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

MEDIAMETADATA_CREATION_TIME

public static final OrderBy MEDIAMETADATA_CREATION_TIME

MEDIAMETADATA_CREATION_TIME_DESC

public static final OrderBy MEDIAMETADATA_CREATION_TIME_DESC

Field Detail

SEPARATOR

public static final java.lang.String SEPARATOR

Separator used to join multiple order configurations.

See Also:

Constant Field Values

Method Detail

values

public static OrderBy[] 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 (OrderBy c : OrderBy.values())
    System.out.println(c);

Returns:

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

valueOf

public static OrderBy valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getRequestValue

public java.lang.String getRequestValue()

String representation of a sort option. Returns a string that is accepted by the Google Photos Library as a parameter.

Returns:

Representation of this order as accepted by the API.