Enum LineSeparatorOption

java.lang.Object
java.lang.Enum<LineSeparatorOption>
com.puppycrawl.tools.checkstyle.checks.LineSeparatorOption
All Implemented Interfaces:
Serializable, Comparable<LineSeparatorOption>, Constable

public enum LineSeparatorOption extends Enum<LineSeparatorOption>
Represents the options for line separator settings.
See Also:
  • Enum Constant Details

    • CRLF

      public static final LineSeparatorOption CRLF
      Windows-style line separators.
    • CR

      public static final LineSeparatorOption CR
      Mac-style line separators.
    • LF

      public static final LineSeparatorOption LF
      Unix-style line separators.
    • LF_CR_CRLF

      public static final LineSeparatorOption LF_CR_CRLF
      Matches CR, LF and CRLF line separators. Only the length is used - the actual value is ignored.
    • SYSTEM

      public static final LineSeparatorOption SYSTEM
      System default line separators.
  • Method Details

    • values

      public static LineSeparatorOption[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static LineSeparatorOption valueOf(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:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null
    • matches

      public boolean matches(byte... bytes)
      Checks that bytes is equal to the byte representation of this line separator.
      Parameters:
      bytes - a bytes array to check
      Returns:
      if bytes is equal to the byte representation of this line separator
    • length

      public int length()
      Returns length of file separator in bytes.
      Returns:
      the length of the file separator in bytes, e.g. 1 for CR, 2 for CRLF, ...