Source code: com/puppycrawl/tools/checkstyle/checks/LeftCurlyOption.java
1 ////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code for adherence to a set of rules.
3 // Copyright (C) 2001-2002 Oliver Burn
4 //
5 // This library is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU Lesser General Public
7 // License as published by the Free Software Foundation; either
8 // version 2.1 of the License, or (at your option) any later version.
9 //
10 // This library is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // Lesser General Public License for more details.
14 //
15 // You should have received a copy of the GNU Lesser General Public
16 // License along with this library; if not, write to the Free Software
17 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 ////////////////////////////////////////////////////////////////////////////////
19 package com.puppycrawl.tools.checkstyle.checks;
20
21 import java.util.HashMap;
22 import java.util.Map;
23
24 /**
25 * Represents the options for placing the left curly brace <code>'{'</code>.
26 *
27 * @author <a href="mailto:oliver@puppycrawl.com">Oliver Burn</a>
28 * @version 1
29 */
30 public final class LeftCurlyOption
31 extends AbstractOption
32 {
33 /** maps from a string representation to an option */
34 private static final Map STR_TO_OPT = new HashMap();
35
36 /**
37 * Represents the policy for placing the brace at the end of line. For
38 * example:
39 * <pre>
40 * if (condition) {
41 * ...
42 * </pre>
43 **/
44 public static final LeftCurlyOption EOL = new LeftCurlyOption("eol");
45
46 /**
47 * Represents the policy that if the brace will fit on the first line of
48 * the statement, taking into account maximum line length, then apply
49 * <code>EOL</code> rule. Otherwise apply the <code>NL</code>
50 * rule. <code>NLOW</code> is a mnemonic for "new line on wrap".
51 *
52 * <p> For the example above Checkstyle will enforce:
53 *
54 * <pre>
55 * if (condition) {
56 * ...
57 * </pre>
58 *
59 * But for a statement spanning multiple lines, Checkstyle will enforce:
60 *
61 * <pre>
62 * if (condition1 && condition2 &&
63 * condition3 && condition4)
64 * {
65 * ...
66 * </pre>
67 **/
68 public static final LeftCurlyOption NLOW = new LeftCurlyOption("nlow");
69
70 /**
71 * Represents the policy that the brace must always be on a new line. For
72 * example:
73 * <pre>
74 * if (condition)
75 * {
76 * ...
77 * </pre>
78 */
79 public static final LeftCurlyOption NL = new LeftCurlyOption("nl");
80
81 /**
82 * Creates a new <code>LeftCurlyOption</code> instance.
83 * @param aStrRep the string representation
84 */
85 private LeftCurlyOption(String aStrRep)
86 {
87 super(aStrRep);
88 }
89
90 /** @see com.puppycrawl.tools.checkstyle.checks.AbstractOption */
91 protected Map getStrToOpt()
92 {
93 return STR_TO_OPT;
94 }
95 }