Module org.refcodes.data
Package org.refcodes.data

Enum Class EndOfLine

java.lang.Object
java.lang.Enum<EndOfLine>
org.refcodes.data.EndOfLine
All Implemented Interfaces:
Serializable, Comparable<EndOfLine>, Constable, org.refcodes.mixin.CharAccessor
public enum EndOfLine extends Enum<EndOfLine> implements org.refcodes.mixin.CharAccessor
Commonly used characters for EOL markers in texts.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

    Nested classes/interfaces inherited from interface org.refcodes.mixin.CharAccessor

    org.refcodes.mixin.CharAccessor.CharBuilder<B extends org.refcodes.mixin.CharAccessor.CharBuilder<B>>, org.refcodes.mixin.CharAccessor.CharMutator, org.refcodes.mixin.CharAccessor.CharProperty

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    CARRIAGE_RETURN
     
    LINE_FEED
     

  • Method Summary

    Modifier and Type
    Method
    Description
    char
    getChar()
    static boolean
    isEndOfLine(char aEndOfLine)
    Tests if the given potential EOL character is contained in the EndOfLine enumeration.
    static char[]
    toChars()
    Returns an array of the characters representing the EOL characters in this grouping enumeration.
    static EndOfLine
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static EndOfLine[]
    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

  • Enum Constant Details

    • CARRIAGE_RETURN

      public static final EndOfLine CARRIAGE_RETURN

    • LINE_FEED

      public static final EndOfLine LINE_FEED

  • Method Details

    • values

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

    • getChar

      public char getChar()
      Specified by:
      getChar in interface org.refcodes.mixin.CharAccessor

    • isEndOfLine

      public static boolean isEndOfLine(char aEndOfLine)
      Tests if the given potential EOL character is contained in the EndOfLine enumeration.
      Parameters:
      aEndOfLine - the potential EOL character
      Returns:
      True, if the given EOL character is contained in the EndOfLine enumeration, else false.

    • toChars

      public static char[] toChars()
      Returns an array of the characters representing the EOL characters in this grouping enumeration.
      Returns:
      The character array of the herein contained EOL characters.