Enum Class WPFormat
- All Implemented Interfaces:
Serializable,Comparable<WPFormat>,Constable,FriendlyEnum,PostFormatEnum
Enum class that represents formats in WordPress.
- Since:
- 0.1.0
- 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 ConstantsEnum ConstantDescriptionThe aside post format, typically short content without a title.The audio post format, featuring an audio clip.The chat post format, displaying a conversation.The gallery post format, displaying a collection of images.The link post format, usually linking to another site.The quote post format, usually a quotation.The standard post format.The status post format, typically a brief status update.The video post format, featuring a video. -
Method Summary
Modifier and TypeMethodDescriptionvalue()Returns the value of the enum constant, which is the actual string to be used in the API.static WPFormatReturns the enum constant of this class with the specified name.static WPFormat[]values()Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
STANDARD
The standard post format. -
ASIDE
The aside post format, typically short content without a title. -
LINK
The link post format, usually linking to another site. -
STATUS
The status post format, typically a brief status update. -
QUOTE
The quote post format, usually a quotation. -
GALLERY
The gallery post format, displaying a collection of images. -
CHAT
The chat post format, displaying a conversation. -
VIDEO
The video post format, featuring a video. -
AUDIO
The audio post format, featuring an audio clip.
-
-
Method Details
-
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
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 nameNullPointerException- if the argument is null
-
value
Description copied from interface:FriendlyEnumReturns 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:
valuein interfaceFriendlyEnum- Returns:
- the value of the enum constant
-