001///////////////////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code and other text files for adherence to a set of rules.
003// Copyright (C) 2001-2024 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.blocks;
021
022/**
023 * Represents the options for placing the left curly brace <code>'{'</code>.
024 *
025 */
026public enum LeftCurlyOption {
027
028    /**
029     * Represents the policy for placing the brace at the end of line. For
030     * example:
031     * <pre>
032     * if (condition) {
033     *     ...
034     * </pre>
035     **/
036    EOL,
037
038    /**
039     * Represents the policy that if the brace will fit on the first line of
040     * the statement, then apply {@code EOL} rule.
041     * Otherwise apply the {@code NL} rule.
042     * {@code NLOW} is a mnemonic for "new line on wrap".
043     *
044     * <p>For the example above Checkstyle will enforce:
045     *
046     * <pre>
047     * if (condition) {
048     *     ...
049     * </pre>
050     *
051     * <p>But for a statement spanning multiple lines, Checkstyle will enforce:
052     *
053     * <pre>
054     * if (condition1 &amp;&amp; condition2 &amp;&amp;
055     *     condition3 &amp;&amp; condition4)
056     * {
057     *     ...
058     * </pre>
059     *
060     **/
061    NLOW,
062
063    /**
064     * Represents the policy that the brace must always be on a new line. For
065     * example:
066     * <pre>
067     * if (condition)
068     * {
069     *     ...
070     * </pre>
071     */
072    NL,
073
074}