Package net.ygbstudio.powerwp4j.models.schema

Enum Class WPQueryParam

java.lang.Object

java.lang.Enum<WPQueryParam>

net.ygbstudio.powerwp4j.models.schema.WPQueryParam

All Implemented Interfaces:

Serializable, Comparable<WPQueryParam>, Constable, FriendlyEnum, QueryParamEnum

public enum WPQueryParam
extends Enum<WPQueryParam>
implements QueryParamEnum

Enumeration of standard WordPress query parameters.

Author:

Yoham Gabriel @ YGBStudio

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
PAGE
PER_PAGE
TIMESTAMP

Method Summary

Modifier and Type	Method	Description
String	value()	Returns the value of the enum constant, which is the actual string to be used in the API.
static WPQueryParam	valueOf(String name)	Returns the enum constant of this class with the specified name.
static WPQueryParam[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PER_PAGE

public static final WPQueryParam PER_PAGE

PAGE

public static final WPQueryParam PAGE

TIMESTAMP

public static final WPQueryParam TIMESTAMP

Method Details

values

public static WPQueryParam[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static WPQueryParam valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

value

public String value()

Description copied from interface: FriendlyEnum

Returns the value of the enum constant, which is the actual string to be used in the API.

Example: If an enum constant is named STATUS_PENDING, the value returned by this method would be "pending", which is the value provided in its constructor.

Specified by:

value in interface FriendlyEnum

Returns:

the value of the enum constant