View Javadoc
1   ///////////////////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3   // Copyright (C) 2001-2026 the original author or authors.
4   //
5   // This library is free software; you can redistribute it and/or
6   // modify it under the terms of the GNU Lesser General Public
7   // License as published by the Free Software Foundation; either
8   // version 2.1 of the License, or (at your option) any later version.
9   //
10  // This library is distributed in the hope that it will be useful,
11  // but WITHOUT ANY WARRANTY; without even the implied warranty of
12  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  // Lesser General Public License for more details.
14  //
15  // You should have received a copy of the GNU Lesser General Public
16  // License along with this library; if not, write to the Free Software
17  // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18  ///////////////////////////////////////////////////////////////////////////////////////////////
19  
20  package com.puppycrawl.tools.checkstyle.checks;
21  
22  import java.nio.charset.StandardCharsets;
23  
24  /**
25   * Represents the options for line ending settings.
26   *
27   * @see LineEndingCheck
28   */
29  public enum LineEndingOption {
30  
31      /** Unix-style line ending. **/
32      LF("\n"),
33  
34      /** Windows-style line ending. **/
35      CRLF("\r\n"),
36  
37      /** Mac-style line ending. **/
38      CR("\r");
39  
40      /** The line ending representation. */
41      private final String lineEnding;
42  
43      /**
44       * Creates a new {@code LineEndingOption} instance.
45       *
46       * @param end the line ending, e.g. "\n"
47       */
48      LineEndingOption(String end) {
49          lineEnding = end;
50      }
51  
52      /**
53       * Checks that bytes is equal to the byte representation of this line ending.
54       *
55       * @param bytes a bytes array to check
56       * @return true if bytes is equal to the byte representation of this line ending.
57       */
58      public boolean matches(byte... bytes) {
59          return lineEnding.equals(new String(bytes, StandardCharsets.US_ASCII));
60      }
61  
62  }