001/////////////////////////////////////////////////////////////////////////////////////////////// 002// checkstyle: Checks Java source code and other text files for adherence to a set of rules. 003// Copyright (C) 2001-2026 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 example: 030 * <pre> 031 * if (condition) { 032 * ... 033 * </pre> 034 */ 035 EOL, 036 037 /** 038 * Represents the policy that if the brace will fit on the first line of 039 * the statement, then apply {@code EOL} rule. 040 * Otherwise apply the {@code NL} rule. 041 * {@code NLOW} is a mnemonic for "new line on wrap". 042 * 043 * <p>For the example above Checkstyle will enforce: 044 * 045 * <pre> 046 * if (condition) { 047 * ... 048 * </pre> 049 * 050 * <p>But for a statement spanning multiple lines, Checkstyle will enforce: 051 * 052 * <pre> 053 * if (condition1 && condition2 && 054 * condition3 && condition4) 055 * { 056 * ... 057 * </pre> 058 * 059 */ 060 NLOW, 061 062 /** 063 * Represents the policy that the brace must always be on a new line. For example: 064 * <pre> 065 * if (condition) 066 * { 067 * ... 068 * </pre> 069 */ 070 NL, 071 072 /** 073 * Represents the policy that if the whole block fits on a single line, 074 * then apply the {@code EOL} rule. 075 * Otherwise apply the {@code NL} rule. 076 * 077 * <p>Checkstyle will allow a block that opens and closes on one line: 078 * 079 * {@snippet lang="text" : 080 * if (condition) { doSomething(); } 081 * } 082 * 083 * <p>But for a block spanning multiple lines, Checkstyle will enforce: 084 * 085 * {@snippet lang="text" : 086 * if (condition) 087 * { 088 * ... 089 * } 090 * } 091 * 092 * @since 14.4.0 093 */ 094 NL_OR_SINGLELINE, 095 096}