Skip to content
This repository was archived by the owner on Jan 18, 2024. It is now read-only.

Commit 3b11c0a

Browse files
rfichtnerrfichtner
committed
added checkstyle check to build
1 parent 67aadd3 commit 3b11c0a

4 files changed

Lines changed: 343 additions & 2 deletions

File tree

‎checkstyle.xml‎

Lines changed: 294 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,294 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE module PUBLIC "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN" "https://checkstyle.org/dtds/configuration_1_3.dtd">
3+
4+
<module name="Checker">
5+
<property name="fileExtensions" value="java, properties"/>
6+
<module name="TreeWalker">
7+
<module name="JavadocMethod">
8+
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
9+
</module>
10+
<module name="JavadocType">
11+
<property name="severity" value="ignore"/>
12+
<property name="scope" value="protected"/>
13+
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
14+
</module>
15+
<module name="JavadocVariable">
16+
<property name="severity" value="ignore"/>
17+
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
18+
</module>
19+
<module name="JavadocStyle">
20+
<property name="severity" value="ignore"/>
21+
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
22+
</module>
23+
<module name="ConstantName">
24+
<property name="id" value="ConstantName"/>
25+
<property name="format" value="^[A-Z_][A-Z0-9]*(_[A-Z0-9]*)*$"/>
26+
</module>
27+
<module name="LocalFinalVariableName">
28+
<property name="id" value="LocalFinalVariableName"/>
29+
<property name="format" value="^[a-z_][a-zA-Z0-9_]*$"/>
30+
</module>
31+
<module name="LocalVariableName">
32+
<property name="id" value="LocalVariableName"/>
33+
<property name="format" value="^[a-z_][a-zA-Z0-9_]*$"/>
34+
</module>
35+
<module name="MemberName">
36+
<property name="id" value="MemberName"/>
37+
<property name="format" value="^[a-z_][a-zA-Z0-9_]*$"/>
38+
</module>
39+
<module name="MethodName">
40+
<property name="id" value="MethodName"/>
41+
<property name="format" value="^[a-zA-Z_][a-zA-Z0-9_]*$"/>
42+
<message key="name.invalidPattern" value="'{0}'' entspricht nicht dem Muster ''{1}''."/>
43+
</module>
44+
<module name="PackageName">
45+
<property name="id" value="PackageName"/>
46+
</module>
47+
<module name="ParameterName">
48+
<property name="id" value="ParameterName"/>
49+
<property name="format" value="^[a-z_][a-zA-Z0-9_]*$"/>
50+
</module>
51+
<module name="StaticVariableName">
52+
<property name="id" value="StaticVariableName"/>
53+
<property name="format" value="^[a-z_][a-zA-Z0-9_]*$"/>
54+
</module>
55+
<module name="TypeName">
56+
<property name="id" value="TypeName"/>
57+
<property name="format" value="^[A-Z_][a-zA-Z0-9_]*$"/>
58+
</module>
59+
<module name="AvoidStarImport">
60+
<property name="id" value="AvoidStarImport"/>
61+
</module>
62+
<module name="IllegalImport">
63+
<property name="id" value="IllegalImport"/>
64+
</module>
65+
<module name="RedundantImport">
66+
<property name="id" value="RedundantImport"/>
67+
</module>
68+
<module name="UnusedImports">
69+
<property name="id" value="UnusedImports"/>
70+
<message key="import.unused" value="Unsed import - {0}."/>
71+
</module>
72+
<module name="MethodLength">
73+
<property name="severity" value="ignore"/>
74+
<property name="id" value="MethodLength"/>
75+
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
76+
</module>
77+
<module name="MethodParamPad">
78+
<property name="severity" value="ignore"/>
79+
<property name="id" value="MethodParamPad"/>
80+
<property name="tokens" value="LITERAL_NEW"/>
81+
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
82+
</module>
83+
<module name="NoWhitespaceAfter">
84+
<property name="severity" value="warning"/>
85+
<property name="id" value="NoWhitespaceAfter"/>
86+
<property name="tokens" value="BNOT,DEC,DOT,INC,LNOT,UNARY_MINUS,UNARY_PLUS,TYPECAST"/>
87+
</module>
88+
<module name="NoWhitespaceBefore">
89+
<property name="id" value="NoWhitespaceBefore"/>
90+
<property name="tokens" value="POST_DEC,POST_INC"/>
91+
</module>
92+
<module name="OperatorWrap">
93+
<property name="id" value="OperatorWrap"/>
94+
</module>
95+
<module name="ParenPad">
96+
<property name="id" value="ParenPad"/>
97+
<property name="tokens" value="ANNOTATION,ANNOTATION_FIELD_DEF,CTOR_DEF,ENUM_CONSTANT_DEF,LITERAL_CATCH,LITERAL_DO,LITERAL_FOR,LITERAL_IF,LITERAL_SWITCH,LITERAL_SYNCHRONIZED,LITERAL_WHILE,METHOD_DEF,RESOURCE_SPECIFICATION,SUPER_CTOR_CALL,QUESTION"/>
98+
</module>
99+
<module name="TypecastParenPad">
100+
<property name="id" value="TypecastParenPad"/>
101+
</module>
102+
<module name="WhitespaceAfter">
103+
<property name="id" value="WhitespaceAfter"/>
104+
<property name="tokens" value="SEMI"/>
105+
</module>
106+
<module name="WhitespaceAround">
107+
<property name="id" value="WhitespaceAround"/>
108+
<property name="tokens" value="ASSIGN,BAND,BAND_ASSIGN,BOR,BOR_ASSIGN,BSR,BSR_ASSIGN,BXOR,BXOR_ASSIGN,COLON,DIV,DIV_ASSIGN,EQUAL,GE,GT,LAND,LCURLY,LE,LOR,LT,MINUS,MINUS_ASSIGN,MOD,MOD_ASSIGN,NOT_EQUAL,PLUS,PLUS_ASSIGN,QUESTION,RCURLY,SL,SLIST,SL_ASSIGN,SR,SR_ASSIGN,STAR,STAR_ASSIGN,TYPE_EXTENSION_AND"/>
109+
</module>
110+
<module name="ModifierOrder">
111+
<property name="id" value="ModifierOrder"/>
112+
</module>
113+
<module name="EmptyBlock">
114+
<property name="id" value="EmptyBlock"/>
115+
</module>
116+
<module name="LeftCurly">
117+
<property name="id" value="LeftCurly"/>
118+
<property name="option" value="nl"/>
119+
</module>
120+
<module name="NeedBraces">
121+
<property name="id" value="NeedBraces"/>
122+
</module>
123+
<module name="RightCurly">
124+
<property name="id" value="RightCurly"/>
125+
<property name="option" value="alone"/>
126+
<property name="tokens" value="LITERAL_TRY,LITERAL_CATCH,LITERAL_FINALLY,LITERAL_IF,LITERAL_ELSE,CLASS_DEF,METHOD_DEF,CTOR_DEF,LITERAL_FOR,LITERAL_WHILE,LITERAL_DO,STATIC_INIT,INSTANCE_INIT"/>
127+
<message key="line.same" value="''{0}'' in Spalte {1} sollte auf der gleichen Linie wie der nächste Teil einer Multi-Block-Anweisung (eine, die direkt mehrere Blöcke enthält: if/else-if/else oder try/catch/finally) sein."/>
128+
</module>
129+
<module name="EmptyStatement">
130+
<property name="id" value="EmptyStatement"/>
131+
</module>
132+
<module name="EqualsHashCode">
133+
<property name="id" value="EqualsHashCode"/>
134+
</module>
135+
<module name="MagicNumber">
136+
<property name="id" value="MagicNumber"/>
137+
</module>
138+
<module name="MissingSwitchDefault">
139+
<message key="missing.switch.default" value="MissingSwitchDefault: switch ohne &quot;default&quot;."/>
140+
</module>
141+
<module name="SimplifyBooleanExpression">
142+
<property name="id" value="SimplifyBooleanExpression"/>
143+
</module>
144+
<module name="HideUtilityClassConstructor">
145+
<property name="id" value="HideUtilityClassConstructor"/>
146+
</module>
147+
<module name="InterfaceIsType">
148+
<property name="id" value="InterfaceIsType"/>
149+
</module>
150+
<module name="VisibilityModifier">
151+
<property name="severity" value="warning"/>
152+
<property name="id" value="VisibilityModifier"/>
153+
<property name="packageAllowed" value="true"/>
154+
<property name="protectedAllowed" value="true"/>
155+
</module>
156+
<module name="ArrayTypeStyle">
157+
<property name="id" value="ArrayTypeStyle"/>
158+
</module>
159+
<module name="FinalParameters">
160+
<property name="id" value="FinalParameters"/>
161+
</module>
162+
<module name="TodoComment">
163+
<property name="severity" value="ignore"/>
164+
<message key="todo.match" value="TodoComment: Comment does not match to-do-Format ''{0}''."/>
165+
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
166+
</module>
167+
<module name="UpperEll">
168+
<property name="id" value="UpperEll"/>
169+
</module>
170+
<module name="RequireThis">
171+
<property name="severity" value="warning"/>
172+
<property name="id" value="RequireThis"/>
173+
</module>
174+
<module name="FinalClass">
175+
<property name="severity" value="warning"/>
176+
<property name="id" value="FinalClass"/>
177+
</module>
178+
<module name="GenericWhitespace">
179+
<property name="severity" value="ignore"/>
180+
<property name="id" value="GenericWhitespace"/>
181+
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="warning"/>
182+
</module>
183+
<module name="EmptyCatchBlock">
184+
<property name="id" value="EmptyCatchBlock"/>
185+
</module>
186+
<module name="NonEmptyAtclauseDescription">
187+
<property name="severity" value="ignore"/>
188+
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
189+
</module>
190+
<module name="AbstractClassName">
191+
<property name="id" value="AbstractClassName"/>
192+
<property name="format" value="^Abstract.*$"/>
193+
</module>
194+
<module name="OuterTypeNumber">
195+
<property name="id" value="OuterTypeNumber"/>
196+
</module>
197+
<module name="DefaultComesLast">
198+
<property name="id" value="DefaultComesLast"/>
199+
</module>
200+
<module name="ExplicitInitialization">
201+
<property name="severity" value="ignore"/>
202+
<property name="id" value="ExplicitInitialization"/>
203+
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
204+
</module>
205+
<module name="NoClone">
206+
<property name="id" value="NoClone"/>
207+
</module>
208+
<module name="NoFinalizer">
209+
<property name="id" value="NoFinalizer"/>
210+
</module>
211+
<module name="StringLiteralEquality">
212+
<property name="id" value="StringLiteralEquality"/>
213+
</module>
214+
<module name="OneStatementPerLine">
215+
<property name="id" value="OneStatementPerLine"/>
216+
</module>
217+
<module name="EmptyForInitializerPad">
218+
<property name="id" value="EmptyForInitializerPad"/>
219+
</module>
220+
<module name="EmptyForIteratorPad">
221+
<property name="id" value="EmptyForIteratorPad"/>
222+
</module>
223+
<module name="OneTopLevelClass">
224+
<property name="id" value="OneTopLevelClass"/>
225+
</module>
226+
<module name="WhitespaceAfter">
227+
<property name="severity" value="ignore"/>
228+
<property name="tokens" value="SEMI,TYPECAST,LITERAL_IF,LITERAL_ELSE,LITERAL_WHILE,LITERAL_DO,LITERAL_FOR,DO_WHILE"/>
229+
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
230+
</module>
231+
<module name="WhitespaceAfter">
232+
<property name="severity" value="ignore"/>
233+
<property name="tokens" value="SEMI,TYPECAST,LITERAL_IF,LITERAL_ELSE,LITERAL_WHILE,LITERAL_DO,LITERAL_FOR,DO_WHILE"/>
234+
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
235+
</module>
236+
<module name="IllegalType">
237+
<!-- java.util.Optional should not be used for parameters. See https://rules.sonarsource.com/java/RSPEC-3553 -->
238+
<property name="tokens" value="PARAMETER_DEF"/>
239+
<property name="illegalClassNames" value="java.util.Optional"/>
240+
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
241+
</module>
242+
</module>
243+
<module name="BeforeExecutionExclusionFileFilter">
244+
<property name="fileNamePattern" value="package\-info\.java$"/>
245+
</module>
246+
<module name="JavadocPackage">
247+
<property name="severity" value="ignore"/>
248+
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
249+
</module>
250+
<module name="LineLength">
251+
<property name="severity" value="ignore"/>
252+
<property name="id" value="LineLength"/>
253+
<property name="max" value="120"/>
254+
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
255+
</module>
256+
<module name="NewlineAtEndOfFile">
257+
<property name="id" value="NewlineAtEndOfFile"/>
258+
</module>
259+
<module name="Translation">
260+
<property name="id" value="Translation"/>
261+
<message key="general.exception" value="general exception"/>
262+
<message key="general.fileNotFound" value="file not found"/>
263+
</module>
264+
<module name="FileLength">
265+
<property name="severity" value="ignore"/>
266+
<property name="id" value="FileLength"/>
267+
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
268+
</module>
269+
<module name="RegexpSingleline">
270+
<metadata name="net.sf.eclipsecs.core.comment" value="Inlined Tabs"/>
271+
<property name="severity" value="ignore"/>
272+
<property name="format" value="^(/*)\t*?[^\n\t/]+?\t"/>
273+
<property name="message" value="Inlined Tab"/>
274+
<property name="fileExtensions" value="java"/>
275+
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
276+
</module>
277+
<module name="RegexpSingleline">
278+
<metadata name="net.sf.eclipsecs.core.comment" value="CheckStyle Off Grund"/>
279+
<property name="format" value="CHECKSTYLE\.OFF\: *([\w\|]+)\s*$"/>
280+
<property name="message" value="Missing reason for checkstyle supression"/>
281+
<property name="fileExtensions" value="java"/>
282+
</module>
283+
<module name="RegexpSingleline">
284+
<metadata name="net.sf.eclipsecs.core.comment" value="CheckStyle All Off Grund"/>
285+
<property name="format" value="CHECKSTYLE\:OFF\s*$"/>
286+
<property name="message" value="Missing reason for checkstyle supression"/>
287+
<property name="fileExtensions" value="java"/>
288+
</module>
289+
<module name="SuppressWithPlainTextCommentFilter">
290+
<property name="offCommentFormat" value="CHECKSTYLE\:OFF\:(\w+)"/>
291+
<property name="onCommentFormat" value="CHECKSTYLE\:ON\:(\w+)"/>
292+
<property name="checkFormat" value="$1"/>
293+
</module>
294+
</module>

‎pom.xml‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -259,6 +259,40 @@
259259
</execution>
260260
</executions>
261261
</plugin>
262+
263+
<plugin>
264+
<groupId>org.apache.maven.plugins</groupId>
265+
<artifactId>maven-checkstyle-plugin</artifactId>
266+
<version>3.1.2</version>
267+
268+
<dependencies>
269+
<dependency>
270+
<groupId>com.puppycrawl.tools</groupId>
271+
<artifactId>checkstyle</artifactId>
272+
<version>8.44</version>
273+
</dependency>
274+
</dependencies>
275+
276+
<configuration>
277+
<configLocation>checkstyle.xml</configLocation>
278+
<encoding>UTF-8</encoding>
279+
<consoleOutput>true</consoleOutput>
280+
<failsOnError>true</failsOnError>
281+
<linkXRef>false</linkXRef>
282+
<failOnViolation>true</failOnViolation>
283+
</configuration>
284+
<executions>
285+
<execution>
286+
<id>validate</id>
287+
<phase>validate</phase>
288+
<goals>
289+
<goal>check</goal>
290+
</goals>
291+
</execution>
292+
</executions>
293+
</plugin>
294+
295+
262296
</plugins>
263297
</build>
264298

‎src/main/java/xdev/ui/UIUtilsFX.java‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
*
3535
* @author XDEV Software
3636
*/
37-
public class UIUtilsFX
37+
public final class UIUtilsFX
3838
{
3939

4040
/**
@@ -48,6 +48,8 @@ private UIUtilsFX()
4848
/**
4949
* Ensures that the runnable is executed in the Java FX thread.
5050
*
51+
* @param runnable to run on Java FX thread.
52+
*
5153
* @since 5.0
5254
*/
5355
public static void runInJFXThread(final Runnable runnable)

‎src/main/java/xdev/ui/XdevBrowser.java‎

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,8 @@ protected WebView createWebView()
6262

6363
/**
6464
* Returns the web view node which is used by this browser.
65+
*
66+
* @return the web view node which is used by this browser.
6567
*/
6668
public WebView getWebView()
6769
{
@@ -71,6 +73,9 @@ public WebView getWebView()
7173

7274
/**
7375
* Returns the web engine which is used by this browser.
76+
*
77+
* @return the web engine which is used by this browser.
78+
*
7479
*/
7580
public WebEngine getWebEngine()
7681
{
@@ -80,6 +85,9 @@ public WebEngine getWebEngine()
8085

8186
/**
8287
* Returns the history of this browser.
88+
*
89+
* @return the history of this browser.
90+
*
8391
*/
8492
public WebHistory getWebHistory()
8593
{
@@ -106,9 +114,12 @@ public void load(final String url)
106114
* cannot be reached via a URL (for example, the HTML text may have come
107115
* from a database). As with {@link #load(String)}, this method is
108116
* asynchronous.
117+
*
118+
* @param html content to load
119+
*
109120
*/
110121
public void loadContent(final String html)
111122
{
112123
UIUtilsFX.runInJFXThread(() -> getWebEngine().loadContent(html));
113124
}
114-
}
125+
}

0 commit comments

Comments
 (0)