Enum Class WPFormat

java.lang.Object
java.lang.Enum<WPFormat>
net.ygbstudio.powerwp4j.models.schema.WPFormat
All Implemented Interfaces:
Serializable, Comparable<WPFormat>, Constable, FriendlyEnum, PostFormatEnum

public enum WPFormat extends Enum<WPFormat> implements 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 Constants
    Enum Constant
    Description
    The 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 Type
    Method
    Description
    Returns the value of the enum constant, which is the actual string to be used in the API.
    static WPFormat
    Returns the enum constant of this class with the specified name.
    static WPFormat[]
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

    • STANDARD

      public static final WPFormat STANDARD
      The standard post format.
    • ASIDE

      public static final WPFormat ASIDE
      The aside post format, typically short content without a title.
    • STATUS

      public static final WPFormat STATUS
      The status post format, typically a brief status update.
    • QUOTE

      public static final WPFormat QUOTE
      The quote post format, usually a quotation.
    • CHAT

      public static final WPFormat CHAT
      The chat post format, displaying a conversation.
    • VIDEO

      public static final WPFormat VIDEO
      The video post format, featuring a video.
    • AUDIO

      public static final WPFormat AUDIO
      The audio post format, featuring an audio clip.
  • Method Details

    • values

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