Source code: com/puppycrawl/tools/checkstyle/checks/RightCurlyOption.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 right curly brace <code>'}'</code>.
26 *
27 * @author <a href="mailto:oliver@puppycrawl.com">Oliver Burn</a>
28 * @version 1
29 */
30 public final class RightCurlyOption
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 that the brace must be alone on the line. For
38 * example:
39 *
40 * <pre>
41 * try {
42 * ...
43 * }
44 * finally {
45 * </pre>
46 **/
47 public static final RightCurlyOption ALONE = new RightCurlyOption("alone");
48
49 /**
50 * Represents the policy that the brace must be on the same line as the
51 * next statement. For example:
52 *
53 * <pre>
54 * try {
55 * ...
56 * } finally {
57 * </pre>
58 **/
59 public static final RightCurlyOption SAME = new RightCurlyOption("same");
60
61 /**
62 * Creates a new <code>RightCurlyOption</code> instance.
63 * @param aStrRep the string representation
64 */
65 private RightCurlyOption(String aStrRep)
66 {
67 super(aStrRep);
68 }
69
70 /** @see com.puppycrawl.tools.checkstyle.checks.AbstractOption */
71 protected Map getStrToOpt()
72 {
73 return STR_TO_OPT;
74 }
75 }