Package net.ygbstudio.powerwp4j.models.schema

Enum Class WPPathField

java.lang.Object

java.lang.Enum<WPPathField>

net.ygbstudio.powerwp4j.models.schema.WPPathField

All Implemented Interfaces:

Serializable, Comparable<WPPathField>, Constable, FriendlyEnum, URLFieldsEnum

public enum WPPathField
extends Enum<WPPathField>
implements URLFieldsEnum

Enum representing the fields that can be requested in a WordPress REST API path.

By default, these field values do not include a trailing slash.

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
FIELD_AUTHOR
FIELD_EXCERPT
FIELD_ID
FIELD_LINK
FIELD_TITLE
FIELDS_BASE

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 WPPathField	valueOf(String name)	Returns the enum constant of this class with the specified name.
static WPPathField[]	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

Methods inherited from interface net.ygbstudio.powerwp4j.base.extension.enums.URLFieldsEnum

joinFields

Enum Constant Details

FIELDS_BASE

public static final WPPathField FIELDS_BASE

FIELD_AUTHOR

public static final WPPathField FIELD_AUTHOR

FIELD_ID

public static final WPPathField FIELD_ID

FIELD_EXCERPT

public static final WPPathField FIELD_EXCERPT

FIELD_TITLE

public static final WPPathField FIELD_TITLE

FIELD_LINK

public static final WPPathField FIELD_LINK

Method Details

values

public static WPPathField[] 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 WPPathField 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