Package org.refcodes.textual

Enum TruncateTextMode

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<TruncateTextMode>
    public enum TruncateTextMode
extends java.lang.Enum<TruncateTextMode>
    The TruncateTextMode specifies for according algorithms on how a line is to be stripped.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      LEFT
      Left stripping according to the given strip chars.
      LEFT_AND_RIGHT
      Both left and right stripping relative to the given strip chars.
      RIGHT
      Right stripping according to the given strip chars.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static TruncateTextMode valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static TruncateTextMode[] 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

      • LEFT

        public static final TruncateTextMode LEFT
        Left stripping according to the given strip chars.

      • LEFT_AND_RIGHT

        public static final TruncateTextMode LEFT_AND_RIGHT
        Both left and right stripping relative to the given strip chars.

      • RIGHT

        public static final TruncateTextMode RIGHT
        Right stripping according to the given strip chars.

    • Method Detail

      • values

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

      • valueOf

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