Source code: com/puppycrawl/tools/checkstyle/checks/blocks/RightCurlyOption.java
1 ////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code for adherence to a set of rules.
3 // Copyright (C) 2001-2003 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.blocks;
20
21 import com.puppycrawl.tools.checkstyle.checks.AbstractOption;
22 import java.util.HashMap;
23 import java.util.Map;
24
25 /**
26 * Represents the options for placing the right curly brace <code>'}'</code>.
27 *
28 * @author Oliver Burn
29 * @version 1
30 */
31 public final class RightCurlyOption
32 extends AbstractOption
33 {
34 /** maps from a string representation to an option */
35 private static final Map STR_TO_OPT = new HashMap();
36
37 /**
38 * Represents the policy that the brace must be alone on the line. For
39 * example:
40 *
41 * <pre>
42 * try {
43 * ...
44 * }
45 * finally {
46 * </pre>
47 **/
48 public static final RightCurlyOption ALONE = new RightCurlyOption("alone");
49
50 /**
51 * Represents the policy that the brace must be on the same line as the
52 * next statement. For example:
53 *
54 * <pre>
55 * try {
56 * ...
57 * } finally {
58 * </pre>
59 **/
60 public static final RightCurlyOption SAME = new RightCurlyOption("same");
61
62 /**
63 * Creates a new <code>RightCurlyOption</code> instance.
64 * @param aStrRep the string representation
65 */
66 private RightCurlyOption(String aStrRep)
67 {
68 super(aStrRep);
69 }
70
71 /** @see com.puppycrawl.tools.checkstyle.checks.AbstractOption */
72 protected Map getStrToOpt()
73 {
74 return STR_TO_OPT;
75 }
76 }