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