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