1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2017 the original author or authors.
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
////////////////////////////////////////////////////////////////////////////////
package com.puppycrawl.tools.checkstyle.checks;
import java.util.Locale;
import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
/**
* Abstract class for checks with a parameter named <tt>option</tt>, where the
* option is identified by a {@link Enum}. The logic to convert from a string
* representation to the {@link Enum} is to {@link String#trim()} the string
* and convert using {@link String#toUpperCase()} and then look up using
* {@link Enum#valueOf}.
* @deprecated Checkstyle will not support abstract checks anymore. Use
* {@link AbstractCheck} instead.
* @author Oliver Burn
* @author Rick Giles
* @param <T> the type of the option.
* @noinspection AbstractClassNeverImplemented
*/
@Deprecated
public abstract class AbstractOptionCheck<T extends Enum<T>>
extends AbstractCheck {
/** Semicolon literal. */
protected static final String SEMICOLON = ";";
/** Since I cannot get this by going <tt>T.class</tt>. */
private final Class<T> optionClass;
/** The policy to enforce. */
private T abstractOption;
/**
* Creates a new {@code AbstractOptionCheck} instance.
* @param literalDefault the default option.
* @param optionClass the class for the option. Required due to a quirk
* in the Java language.
*/
protected AbstractOptionCheck(T literalDefault, Class<T> optionClass) {
abstractOption = literalDefault;
this.optionClass = optionClass;
}
/**
* Set the option to enforce.
* @param optionStr string to decode option from
* @throws IllegalArgumentException if unable to decode
*/
public void setOption(String optionStr) {
try {
abstractOption =
Enum.valueOf(optionClass, optionStr.trim().toUpperCase(Locale.ENGLISH));
}
catch (IllegalArgumentException iae) {
throw new IllegalArgumentException("unable to parse " + optionStr, iae);
}
}
/**
* Gets AbstractOption set.
* @return the {@code AbstractOption} set
*/
public T getAbstractOption() {
// WARNING!! Do not rename this method to getOption(). It breaks
// BeanUtils, which will silently not call setOption. Very annoying!
return abstractOption;
}
}
|
