001///////////////////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code and other text files for adherence to a set of rules.
003// Copyright (C) 2001-2025 the original author or authors.
004//
005// This library is free software; you can redistribute it and/or
006// modify it under the terms of the GNU Lesser General Public
007// License as published by the Free Software Foundation; either
008// version 2.1 of the License, or (at your option) any later version.
009//
010// This library is distributed in the hope that it will be useful,
011// but WITHOUT ANY WARRANTY; without even the implied warranty of
012// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
013// Lesser General Public License for more details.
014//
015// You should have received a copy of the GNU Lesser General Public
016// License along with this library; if not, write to the Free Software
017// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
018///////////////////////////////////////////////////////////////////////////////////////////////
019
020package com.puppycrawl.tools.checkstyle.checks;
021
022import java.nio.charset.StandardCharsets;
023import java.util.Arrays;
024
025/**
026 * Represents the options for line ending settings.
027 *
028 * @see LineEndingCheck
029 */
030public enum LineEndingOption {
031
032    /** Windows-style line ending. **/
033    CRLF("\r\n"),
034
035    /** Unix-style line ending. **/
036    LF("\n");
037
038    /** Carriage return character ('\r'). */
039    private static final byte CARRIAGE_RETURN = '\r';
040
041    /** The line ending representation. */
042    private final byte[] lineEnding;
043
044    /**
045     * Creates a new {@code LineEndingOption} instance.
046     *
047     * @param end the line separator, e.g. "\n"
048     */
049    LineEndingOption(String end) {
050        lineEnding = end.getBytes(StandardCharsets.US_ASCII);
051    }
052
053    /**
054     * Checks that bytes is equal to the byte representation of this line ending.
055     *
056     * @param bytes a bytes array to check
057     * @return true if bytes is equal to the byte representation of this line ending.
058     */
059    public boolean matches(byte... bytes) {
060        return Arrays.equals(lineEnding, bytes);
061    }
062
063    /**
064     * Checks that value is equal to the byte representation of carriage return.
065     *
066     * @param value a byte to check
067     * @return true if value is equal to byte representation of carriage return.
068     */
069    public static boolean isCarriageReturn(byte value) {
070        return value == CARRIAGE_RETURN;
071    }
072}