Package com.github.vbauer.yta.model.basic

Enum TextFormat

  • All Implemented Interfaces:
    HasCode<java.lang.String>, java.io.Serializable, java.lang.Comparable<TextFormat>
    @ThreadSafe
public enum TextFormat
extends java.lang.Enum<TextFormat>
implements HasCode<java.lang.String>
    Text format could be used in the following services: It allows to specify kind of source text.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      HTML
      Text in HTML format.
      PLAIN_TEXT
      Text without markup.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String code()
      Get code value.
      static TextFormat getOrDefault​(TextFormat format)
      Check if it possible to use format parameter or use default value.
      static TextFormat valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static TextFormat[] 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

      • PLAIN_TEXT

        public static final TextFormat PLAIN_TEXT
        Text without markup.

      • HTML

        public static final TextFormat HTML
        Text in HTML format.

    • Method Detail

      • values

        public static TextFormat[] 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 (TextFormat c : TextFormat.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static TextFormat 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

      • getOrDefault

        @Nonnull
public static TextFormat getOrDefault​(TextFormat format)
        Check if it possible to use format parameter or use default value.
        Parameters:
        format - text format
        Returns:
        format if it is not null or PLAIN_TEXT otherwise

      • code

        @Nonnull
public java.lang.String code()
        Get code value.
        Specified by:
        code in interface HasCode<java.lang.String>
        Returns:
        code