KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > puppycrawl > tools > checkstyle > checks > whitespace > PadOption


1 ////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code for adherence to a set of rules.
3 // Copyright (C) 2001-2005 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.whitespace;
20
21 import com.puppycrawl.tools.checkstyle.checks.AbstractOption;
22 import java.util.HashMap JavaDoc;
23 import java.util.Map JavaDoc;
24
25 /**
26  * Represents the options for whitespace around parentheses.
27  *
28  * @author Oliver Burn
29  * @version 1
30  * @see EmptyForIteratorPadCheck
31  * @see ParenPadCheck
32  */
33 public final class PadOption
34     extends AbstractOption
35 {
36     /** maps from a string representation to an option */
37     private static final Map JavaDoc STR_TO_OPT = new HashMap JavaDoc();
38
39     /**
40      * Represents no spacing following a left parenthesis
41      * or preceding a right one.
42      */
43     public static final PadOption NOSPACE = new PadOption("nospace");
44     /**
45      * Represents mandatory spacing following a left parenthesis
46      * and preceeing a right one.
47      */
48     public static final PadOption SPACE = new PadOption("space");
49
50     /**
51      * Creates a new <code>PadOption</code> instance.
52      * @param aStrRep the string representation
53      */
54     private PadOption(String JavaDoc aStrRep)
55     {
56         super(aStrRep);
57     }
58
59     /** {@inheritDoc} */
60     protected Map JavaDoc getStrToOpt()
61     {
62         return STR_TO_OPT;
63     }
64 }
65
Popular Tags