checkstyle.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN" "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">

<!-- Checkstyle-Configuration: lafaspot checks Description: none -->
<module name="Checker">
	<property name="severity" value="warning" />
	<module name="TreeWalker">
		<property name="tabWidth" value="4" />
		<module name="JavadocMethod">
		</module>
		<module name="JavadocType" />
		<module name="JavadocVariable" />
		<module name="JavadocStyle" />
		<module name="ConstantName" />
		<module name="LocalFinalVariableName" />
		<module name="LocalVariableName" />
		<module name="MemberName" />
		<module name="MethodName" />
		<module name="PackageName" />
		<module name="ParameterName" />
		<module name="StaticVariableName" />
		<module name="TypeName" />
		<module name="AvoidStarImport" />
		<module name="SuppressionCommentFilter" />
		<module name="IllegalImport">
			<property name="severity" value="error" />
			<property name="illegalPkgs" value="edu.emory.mathcs.backport.java.util, org.ocpsoft.prettytime.shade.edu.emory.mathcs.backport.java.util, org.apache.log4j, yjava.messaging.ynet, yjava.security.ysecure, yjava.security.yck, yjava.security.yhdrs, , yjava.messaging.ynet" />
			<message key="import.illegal" value="Import from illegal package - {0}." />
		</module>
		<module name="RedundantImport" />
		<module name="UnusedImports" />
		<module name="ParameterNumber" />
		<module name="EmptyForIteratorPad" />
		<module name="MethodParamPad" />
		<module name="NoWhitespaceAfter">
			<property name="tokens"
					  value="BNOT,DEC,DOT,INC,LNOT,UNARY_MINUS,UNARY_PLUS" />
		</module>
		<module name="NoWhitespaceBefore" />
		<module name="OperatorWrap" />
		<module name="ParenPad" />
		<module name="TypecastParenPad" />
		<module name="WhitespaceAfter" />
		<module name="WhitespaceAround" />
		<module name="ModifierOrder" />
		<module name="RedundantModifier" />
		<module name="AvoidNestedBlocks">
			<property name="severity" value="ignore" />
		</module>
		<module name="EmptyBlock">
			<property name="option" value="text" />
		</module>
		<module name="LeftCurly" />
		<module name="NeedBraces" />
		<module name="RightCurly" />
		<module name="EmptyStatement" />
		<module name="EqualsHashCode" />
		<module name="IllegalInstantiation" />
		<module name="InnerAssignment">
			<property name="severity" value="ignore" />
		</module>
		<module name="MagicNumber" />
		<module name="MissingSwitchDefault" />
		<module name="SimplifyBooleanExpression" />
		<module name="SimplifyBooleanReturn" />
		<module name="FinalClass" />
		<module name="HideUtilityClassConstructor" />
		<module name="InterfaceIsType" />
		<module name="VisibilityModifier">
			<property name="protectedAllowed" value="true" />
		</module>
		<module name="ArrayTypeStyle" />
		<module name="FinalParameters" />
		<module name="IllegalCatch">
			<property name="illegalClassNames"
					  value="java.lang.Exception, java.lang.Throwable, java.lang.RuntimeException, java.lang.IllegalArgumentException, java.lang.IllegalStateException, java.lang.UnsupportedOperationException, java.lang.NumberFormatException,
                 java.lang.NullPointerException, java.lang.StringIndexOutOfBoundsException, java.lang.ArrayIndexOutOfBoundsException, java.util.NoSuchElementException, java.util.MissingResourceException,
                 javax.ws.rs.NotSupportedException, javax.ws.rs.BadRequestException, javax.ws.rs.ProcessingException, javax.ws.rs.core.UriBuilderException" />
		</module>
		<module name="IllegalThrows">
			<property name="illegalClassNames"
					  value="java.lang.Exception, java.lang.Throwable, java.lang.RuntimeException, java.lang.IllegalArgumentException, java.lang.IllegalStateException, java.lang.UnsupportedOperationException, java.lang.NumberFormatException,
                 java.lang.NullPointerException, java.lang.StringIndexOutOfBoundsException, java.lang.ArrayIndexOutOfBoundsException, java.util.NoSuchElementException, java.util.MissingResourceException,
                 javax.ws.rs.NotSupportedException, javax.ws.rs.BadRequestException, javax.ws.rs.ProcessingException, javax.ws.rs.core.UriBuilderException" />
		</module>
		<module name="IllegalInstantiation">
			<property name="classes" value="java.net.URLEncoder"/>
			<property name="classes" value="java.net.URLDecoder"/>
			<property name="classes" value="javax.mail.internet.InternetAddress"/>
		</module>
		<module name="TodoComment">
			<property name="severity" value="ignore" />
			<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity"
					  value="inherit" />
		</module>
		<module name="UpperEll" />
		<module name="RegexpSinglelineJava">
			<property name="format" value="System\.(out|err|in|exit)" />
			<property name="message"
					  value="Prohibited System.out/err/in/exit reference(s)." />
			<property name="ignoreComments" value="true"/>
		</module>
		<module name="RegexpSinglelineJava">
			<property name="format" value="Charset\.getDefaultCharset\(\)"/>
			<property name="message" value="Usage of Charset.getDefaultCharset() is prohibited." />
			<property name="ignoreComments" value="true"/>
		</module>
		<module name="RegexpSinglelineJava">
			<property name="format" value="\.getBytes\(&quot;(.*)&quot;\)"/>
			<property name="message" value="Possible usage of String.getBytes() with String to specific Charset." />
			<property name="ignoreComments" value="true"/>
		</module>
		<module name="RegexpSinglelineJava">
			<property name="format" value="@Test.*dependsOn(Groups|Methods).*" />
			<property name="message"
					  value="Prohibited TestNG dependsOn due to issues with parallelization.  Make all tests run independently." />
			<property name="ignoreComments" value="true"/>
		</module>
		<module name="RegexpSinglelineJava">
			<property name="format" value="\.submit\([a-zA-Z]*[Ww]orker, null\)" />
			<property name="message"
					  value="Prohibited use of submit with null passed as handler. Please use WorkerExceptionStatsHandler." />
			<property name="ignoreComments" value="true"/>
		</module>
		<module name="RegexpSinglelineJava">
			<property name="format" value="\.printStackTrace\(\)"/>
			<property name="message" value="Using e.printStackTrace() is forbidden. Rethrow, log or handle the exception."/>
			<property name="ignoreComments" value="true"/>
		</module>
		<module name="RegexpSinglelineJava">
			<property name="format" value="white[ -]?list|black[ -]?list|slave|black[ -]?hat|white[ -]?hat|master"/>
			<property name="message" value="Forbidden word is used. Instead, use inclusive language."/>
			<property name="ignoreCase" value="true"/>
			<property name="ignoreComments" value="false"/>
		</module>
		<module name="RegexpSinglelineJava">
			<property name="format" value="StringUtils\.isBlank\(\)"/>
			<property name="message" value="Usage of StringUtils.isBlank() is prohibited.  Instead use String.isBlank()" />
			<property name="ignoreComments" value="true"/>
		</module>
	</module>
	<!--
    A multiline regex matcher for the illegal ConfigGets (of type ValueType.StringList). It can detect the invalid default values like:
    "[Personal]"
    "[ Personal ]"
    "[    Personal    ]"
    "[Personal, Unknown]"
    "[ Personal, Unknown ]"
    "[\"Unknown]"

    It will not detect the valid default values like:
    "[ ]"
    "[]"
    "[\"Personal\", \"Unknown\", \"ghjgjggjhgjgjghjgjhg \"]"
    "[ \"Personal\", \"Unknown\" ]"
    "[ \"Personal\", \"Unknown\"]"
    "[   \"Personal\", \"Unknown\"]"
    "[\"Personal\", \"Unknown\"]"
    "[\"Personal\", \"Unknown\" ]"
    "[\"Personal\", \"Unknown\"   ]"
    "[    \"Personal\", \"Unknown\"    ]"
    "[\"Unknown\"]"
    ""
    "Personal"
    "Personal, Unknown"

    Refer https://regex101.com/r/iX3QQT/6/tests for the regex and the corresponding tests.
     -->
	<module name="RegexpMultiline">
		<property name="format" value="type = ValueType\.StringList,\s*defaultValue = \&quot;\[ *[^\\ ][^&quot;]\S+( |\S)+[^\\][^&quot; ] *\]\&quot;\)$"/>
		<property name="message" value="Default value for StringList should be a string representation of an array of strings."/>
	</module>
	<module name="RegexpMultiline">
		<property name="format" value="ConfigManager\s*\.\s*INSTANCE\s*\.\s*getConfig"/>
		<property name="message" value="Use application/service context to get config."/>
	</module>
	<module name="JavadocPackage">
		<property name="allowLegacy" value="true" />
	</module>
	<module name="NewlineAtEndOfFile">
		<property name="severity" value="ignore" />
		<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity"
				  value="inherit" />
	</module>
	<module name="Translation" />
	<module name="FileLength" />
	<module name="FileTabCharacter">
		<property name="severity" value="ignore" />
		<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity"
				  value="inherit" />
	</module>
	<module name="RegexpSingleline">
		<property name="severity" value="ignore" />
		<property name="format" value="\s+$" />
		<property name="message" value="Line has trailing spaces." />
		<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity"
				  value="inherit" />
	</module>

	<module name="SuppressionFilter">
		<property name="file"
				  value="${config_loc}/checkstyle_suppressions.xml" />
	</module>
</module>