All Downloads are FREE. Search and download functionalities are using the official Maven repository.

om.liferay.source.formatter.1.0.1028.source-code.checkstyle.xml Maven / Gradle / Ivy

There is a newer version: 1.0.1437
Show newest version
<?xml version="1.0"?>
<!DOCTYPE module PUBLIC "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN" "https://checkstyle.org/dtds/configuration_1_3.dtd">

<module name="Checker">
	<module name="TreeWalker">
		<property name="tabWidth" value="4" />
		<module name="AnnotationUseStyleCheck">
			<property name="category" value="Styling" />
			<property name="description" value="Checks the style of elements in annotations." />
			<property name="documentationLocation" value="config_annotation.html#AnnotationUseStyle" />
		</module>
		<module name="ArrayTypeStyleCheck">
			<property name="category" value="Styling" />
			<property name="description" value="Checks the style of array type definitions." />
			<property name="documentationLocation" value="config_misc.html#ArrayTypeStyle" />
		</module>
		<module name="AvoidNestedBlocksCheck">
			<property name="category" value="Styling" />
			<property name="description" value="Finds nested blocks (blocks that are used freely in the code)." />
			<property name="documentationLocation" value="config_blocks.html#AvoidNestedBlocks" />
		</module>
		<module name="AvoidStarImportCheck">
			<property name="category" value="Bug Prevention" />
			<property name="description" value="Checks that there are no import statements that use the * notation." />
			<property name="documentationLocation" value="config_imports.html#AvoidStarImport" />
		</module>
		<module name="DefaultComesLastCheck">
			<property name="category" value="Styling" />
			<property name="description" value="Check that the default is after all the cases in a switch statement." />
			<property name="documentationLocation" value="config_coding.html#DefaultComesLast" />
		</module>
		<module name="JavadocStyleCheck">
			<property name="category" value="Styling" />
			<property name="checkFirstSentence" value="false" />
			<property name="description" value="Validates Javadoc comments to help ensure they are well formed." />
			<property name="documentationLocation" value="config_javadoc.html#JavadocStyle" />
		</module>
		<module name="LocalFinalVariableNameCheck">
			<property name="category" value="Naming Conventions" />
			<property name="description" value="Checks that local final variable names conform to a specified pattern." />
			<property name="documentationLocation" value="config_naming.html#LocalFinalVariableName" />
			<property name="format" value="^[a-z0-9][_a-zA-Z0-9]*$" />
			<message key="name.invalidPattern" value="Local final variable ''{0}'' must match pattern ''{1}''" />
		</module>
		<module name="LocalVariableNameCheck">
			<property name="category" value="Naming Conventions" />
			<property name="description" value="Checks that local, non-final variable names conform to a specified pattern." />
			<property name="documentationLocation" value="config_naming.html#LocalVariableName" />
			<property name="format" value="^[a-z0-9][_a-zA-Z0-9]*$" />
			<message key="name.invalidPattern" value="Local non-final variable ''{0}'' must match pattern ''{1}''" />
		</module>
		<module name="MemberNameCheck">
			<property name="applyToPackage" value="false" />
			<property name="applyToPrivate" value="false" />
			<property name="category" value="Naming Conventions" />
			<property name="description" value="Checks that instance variable names conform to a specified pattern." />
			<property name="documentationLocation" value="config_naming.html#MemberName" />
			<property name="format" value="^[a-z0-9][_a-zA-Z0-9]*$" />
			<message key="name.invalidPattern" value="Protected or public non-static field ''{0}'' must match pattern ''{1}''" />
		</module>
		<module name="MemberNameCheck">
			<property name="applyToProtected" value="false" />
			<property name="applyToPublic" value="false" />
			<property name="category" value="Naming Conventions" />
			<property name="description" value="Checks that instance variable names conform to a specified pattern." />
			<property name="documentationLocation" value="config_naming.html#MemberName" />
			<property name="format" value="^_[a-z0-9][_a-zA-Z0-9]*$" />
			<message key="name.invalidPattern" value="Private non-static field ''{0}'' must match pattern ''{1}''" />
		</module>
		<module name="MethodNameCheck">
			<property name="applyToPackage" value="false" />
			<property name="applyToPrivate" value="false" />
			<property name="category" value="Naming Conventions" />
			<property name="description" value="Checks that method names conform to a specified pattern." />
			<property name="documentationLocation" value="config_naming.html#MethodName" />
			<property name="format" value="^[a-z0-9][_a-zA-Z0-9]*$" />
			<message key="name.invalidPattern" value="Protected or public method ''{0}'' must match pattern ''{1}''" />
		</module>
		<module name="MethodNameCheck">
			<property name="applyToProtected" value="false" />
			<property name="applyToPublic" value="false" />
			<property name="category" value="Naming Conventions" />
			<property name="description" value="Checks that method names conform to a specified pattern." />
			<property name="documentationLocation" value="config_naming.html#MethodName" />
			<property name="format" value="^_[a-z0-9][_a-zA-Z0-9]*$|readObject|writeObject" />
			<message key="name.invalidPattern" value="Private method ''{0}'' must match pattern ''{1}''" />
		</module>
		<module name="MethodParamPadCheck">
			<property name="category" value="Styling" />
			<property name="description" value="Checks the padding between the identifier of a method definition, constructor definition, method call, or constructor invocation; and the left parenthesis of the parameter list." />
			<property name="documentationLocation" value="config_whitespace.html#MethodParamPad" />
		</module>
		<module name="MissingDeprecatedCheck">
			<property name="category" value="Styling" />
			<property name="description" value="Verifies that the annotation @Deprecated and the Javadoc tag @deprecated are both present when either of them is present." />
			<property name="documentationLocation" value="config_annotation.html#MissingDeprecated" />
		</module>
		<module name="ModifierOrderCheck">
			<property name="category" value="Styling" />
			<property name="description" value="Checks that the order of modifiers conforms to the suggestions in the Java Language specification, § 8.1.1, 8.3.1, 8.4.3 and 9.4." />
			<property name="documentationLocation" value="config_modifier.html#ModifierOrder" />
		</module>
		<module name="MultipleVariableDeclarationsCheck">
			<property name="category" value="Styling" />
			<property name="description" value="Checks that each variable declaration is in its own statement and on its own line." />
			<property name="documentationLocation" value="config_coding.html#MultipleVariableDeclarations" />
		</module>
		<module name="NoLineWrapCheck">
			<property name="category" value="Styling" />
			<property name="description" value="Checks that chosen statements are not line-wrapped." />
			<property name="documentationLocation" value="config_whitespace.html#NoLineWrap" />
		</module>
		<module name="NoWhitespaceAfterCheck">
			<property name="category" value="Styling" />
			<property name="description" value="Checks that there is no whitespace after a token." />
			<property name="documentationLocation" value="config_whitespace.html#NoWhitespaceAfter" />
			<property name="tokens" value="ARRAY_DECLARATOR, ARRAY_INIT, BNOT, DEC, DOT, INC, INDEX_OP, LNOT, TYPECAST, UNARY_MINUS, UNARY_PLUS" />
		</module>
		<module name="NoWhitespaceBeforeCheck">
			<property name="category" value="Styling" />
			<property name="description" value="Checks that there is no whitespace before a token." />
			<property name="documentationLocation" value="config_whitespace.html#NoWhitespaceBefore" />
		</module>
		<module name="OneStatementPerLineCheck">
			<property name="category" value="Styling" />
			<property name="description" value="Checks that there is only one statement per line." />
			<property name="documentationLocation" value="config_coding.html#OneStatementPerLine" />
		</module>
		<module name="OperatorWrapCheck">
			<property name="category" value="Styling" />
			<property name="description" value="Checks the policy on how to wrap lines on operators." />
			<property name="documentationLocation" value="config_whitespace.html#OperatorWrap" />
			<property name="option" value="eol" />
			<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, LE, LITERAL_INSTANCEOF, LOR, LT, MINUS, MINUS_ASSIGN, MOD, MOD_ASSIGN, NOT_EQUAL, PLUS, PLUS_ASSIGN, QUESTION, SL, SL_ASSIGN, SR, SR_ASSIGN, STAR, STAR_ASSIGN, TYPE_EXTENSION_AND" />
		</module>
		<module name="PackageNameCheck">
			<property name="category" value="Naming Conventions" />
			<property name="description" value="Checks that package names conform to a specified pattern." />
			<property name="documentationLocation" value="config_naming.html#PackageName" />
		</module>
		<module name="ParameterNameCheck">
			<property name="category" value="Naming Conventions" />
			<property name="description" value="Checks that method parameter names conform to a specified pattern." />
			<property name="documentationLocation" value="config_naming.html#ParameterName" />
			<message key="name.invalidPattern" value="Parameter ''{0}'' must match pattern ''{1}''" />
		</module>
		<module name="RequireThisCheck">
			<property name="category" value="Bug Prevention" />
			<property name="description" value="Checks that references to instance variables and methods of the present object are explicitly of the form 'this.varName' or 'this.methodName(args)' and that those references don't rely on the default behavior when 'this.' is absent." />
			<property name="documentationLocation" value="config_coding.html#RequireThis" />
		</module>
		<module name="StaticVariableNameCheck">
			<property name="applyToPackage" value="false" />
			<property name="applyToPrivate" value="false" />
			<property name="category" value="Naming Conventions" />
			<property name="description" value="Checks that static, non-final variable names conform to a specified pattern." />
			<property name="documentationLocation" value="config_naming.html#StaticVariableName" />
			<property name="format" value="^[a-z0-9][_a-zA-Z0-9]*$" />
			<message key="name.invalidPattern" value="Protected or public static non-final field ''{0}'' must match pattern ''{1}''" />
		</module>
		<module name="StaticVariableNameCheck">
			<property name="applyToProtected" value="false" />
			<property name="applyToPublic" value="false" />
			<property name="category" value="Naming Conventions" />
			<property name="description" value="Checks that static, non-final variable names conform to a specified pattern." />
			<property name="documentationLocation" value="config_naming.html#StaticVariableName" />
			<property name="format" value="^_[a-z0-9][_a-zA-Z0-9]*$" />
			<message key="name.invalidPattern" value="Private static non-final field ''{0}'' must match pattern ''{1}''" />
		</module>
		<module name="StringLiteralEqualityCheck">
			<property name="category" value="Styling" />
			<property name="description" value="Checks that string literals are not used with == or !=." />
			<property name="documentationLocation" value="config_coding.html#StringLiteralEquality" />
		</module>
		<module name="TypeNameCheck">
			<property name="category" value="Naming Conventions" />
			<property name="description" value="Checks that type names conform to a specified pattern." />
			<property name="documentationLocation" value="config_naming.html#TypeName" />
			<property name="format" value="^[A-Z][_a-zA-Z0-9]*" />
			<message key="name.invalidPattern" value="Class, interface, enum or annotation ''{0}'' must match pattern ''{1}''" />
		</module>
		<module name="UnnecessaryParenthesesCheck">
			<property name="category" value="Styling" />
			<property name="description" value="Checks if unnecessary parentheses are used in a statement or expression." />
			<property name="documentationLocation" value="config_coding.html#UnnecessaryParentheses" />
		</module>
		<module name="WhitespaceAfterCheck">
			<property name="category" value="Styling" />
			<property name="description" value="Checks that a token is followed by whitespace, with the exception that it does not check for whitespace after the semicolon of an empty for iterator." />
			<property name="documentationLocation" value="config_whitespace.html#WhitespaceAfter" />
			<property name="tokens" value="COMMA, SEMI" />
		</module>
		<module name="WhitespaceAroundCheck">
			<property name="allowEmptyTypes" value="true" />
			<property name="category" value="Styling" />
			<property name="description" value="Checks that a token is surrounded by whitespace." />
			<property name="documentationLocation" value="config_whitespace.html#WhitespaceAround" />
		</module>

		<!-- Custom checks -->

		<module name="com.liferay.source.formatter.checkstyle.checks.AnnotationParameterOrderCheck">
			<message key="annotation.unsortedParameter" value="Annotation parameter ''{0}'' is not sorted alphabetically" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.AnonymousClassCheck">
			<message key="anonymous.class.incorrect" value="Do not use anonymous class for variable ''{0}''. This causes (de)serialization issues when passed to method call ''{1}''." />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.AppendCheck">
			<message key="end.character.invalid" value="When appending multiple literal strings, only the last literal string can end with ''{0}''" />
			<message key="line.break.incorrect" value="Avoid using line break when appending multiple literal strings" />
			<message key="literal.string.combine" value="Combine the literal strings ''{0}'' and ''{1}''" />
			<message key="literal.string.move" value="Add the string ''{0}'' to the previous literal string" />
			<message key="plus.incorrect" value="Incorrect use of ''+'' inside StringBundler" />
			<message key="start.character.invalid" value="When appending multiple literal strings, only the first literal string can start with ''{0}''" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.ArquillianCheck">
			<message key="import.invalid" value="Use import ''com.liferay.arquillian.extension.junit.bridge.junit.Arquillian'' instead of ''org.jboss.arquillian.junit.Arquillian'', see LPS-68945" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.AssertEqualsCheck">
			<message key="assert.add.information" value="Add ''{0}'' as extra parameter at the beginning of the ''Assert.assertEquals'' call to provide more information to the test. See LPS-70411." />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.AttributeOrderCheck">
			<message key="attribute.incorrect.order" value="Attribute ''{0}'' should come after attribute ''{1}''" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.CamelCaseNameCheck">
			<property name="enabled" value="false" />
			<message key="following.underscore.incorrect" value="''{0}'' should not be followed by ''_'' for variable ''{1}''" />
			<message key="following.uppercase.incorrect" value="''{0}'' should not be followed by an uppercase character for {1} ''{2}''" />
			<message key="preceding.underscore.required" value="''{0}'' should be preceded by ''_'' for variable ''{1}''" />
			<message key="starting.uppercase.required" value="''{0}'' should start with an uppercase character for {1} ''{2}''" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.ChainingCheck">
			<property name="allowedClassNames" value="ActionSemantics,.*[Bb]uilder(s)?,Assertions,Awaitility,.*Consumer,CreationMenuBuilder,DSL.+FactoryUtil,EasyMock,Either,Filter,FormNavigatorEntryConfigurationRetriever,GenericUtil,InfoFieldSet,InfoForm,InfoFormValues,JSONUtil,List,MemberMatcher,Option,Optional,Response,RestAssured,(Double|Int|Long)?Stream,.+Table,Try,Validation" />
			<property name="allowedMethodNames" value="bind,builder,newBuilder" />
			<property name="allowedMockitoMethodNames" value="doAnswer,doCallRealMethod,doNothing,doReturn,doThrow,field,replace,stub,verify,verifyPrivate,when" />
			<property name="allowedVariableTypeNames" value="^(?!String).+Builder(Impl)?,Column,CompletableFuture,.*Consumer,ContactsEngineClient,Dataset,Description,ExecuteActionRequest,(FormsEventDataset)?Filter,.*Function[0-9]*,HttpSecurity,InOrder,JSONArray,JSONObject,JsonPath,.*Mapper,NestedRepresentor.*,Optional,Predicate,RequestSpecification,Response,SoyContext,.+Step,(Double|Int|Long)?Stream,Try,UpdateFieldPropertyRequest,ValidatableResponse,WebTarget" />
			<property name="applyToTypeCast" value="true" />
			<property name="category" value="Styling" />
			<property name="description" value="Checks that chaining is only applied on certain types and methods" />
			<message key="chaining.allowed" value="Chaining is allowed on ''{0}''" />
			<message key="chaining.avoid.method" value="Avoid chaining on method ''{0}''" />
			<message key="chaining.avoid.new.instance" value="Avoid chaining on new class instantiation" />
			<message key="chaining.avoid.type.cast" value="Avoid chaining on Type Cast" />
			<message key="chaining.required" value="Chaining on ''{0}'' is preferred" />
			<message key="concat.avoid.too.many" value="Use StringBundler instead of chaining concat when there is more than 3 parts" />
			<message key="response.unsorted" value="Method calls between ''Response.status'' and ''Response.build'' should be sorted" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.ConcatCheck">
			<message key="end.character.invalid" value="When concatenating multiple literal strings, only the last literal string can end with ''{0}''" />
			<message key="literal.string.combine" value="Combine the literal strings ''{0}'' and ''{1}''" />
			<message key="literal.string.move" value="Add the string ''{0}'' to the previous literal string" />
			<message key="plus.incorrect" value="Do not use ''+'' inside ''StringBundler.concat''" />
			<message key="start.character.invalid" value="When concatenating multiple literal strings, only the first literal string can start with ''{0}''" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.ConstantNameCheck">
			<property name="camelCaseTypeNames" value="AggregateTestRule,Atomic.*,CodeCoverageAssertor,LiferayIntegrationTestRule,Log,Pattern,TestRule" />
			<property name="immutableFieldTypes" value="boolean,byte,char,double,float,int,long,short,Boolean,Byte,Character,Class,Double,Float,Int,Long,Number,Short,String" />
			<message key="name.invalidConstantPattern" value="{0} constant ''{1}'' must match pattern ''{2}''" />
			<message key="name.invalidConstantTypePattern" value="{0} constant ''{1}'' of type ''{2}'' must match pattern ''{3}''" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.ConstructorMissingEmptyLineCheck">
			<message key="empty.line.missing" value="There should be an empty line before line ''{0}''" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.ContractionsCheck">
			<message key="contraction.avoid" value="Avoid using contraction ''{0}''" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.CreationMenuBuilderCheck">
			<property name="checkInline" value="true" />
			<property name="enabled" value="false" />
			<message key="builder.include" value="Include method call ''{0}'' ({1}) in ''{2}'' ({3})" />
			<message key="builder.inline" value="Inline variable definition ''{0}'' ({1}) inside ''{2}'' ({3})" />
			<message key="builder.use" value="Use ''{0}'' ({1}, {2})" />
			<message key="builder.use.instead" value="Use ''{0}'' instead of new instance of ''{1}''" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.DeprecatedUsageCheck">
			<property name="enabled" value="false" />
			<message key="constructor.call.deprecated" value="Constructor ''{0}'' has been deprecated" />
			<message key="field.call.deprecated" value="Field ''{0}'' has been deprecated" />
			<message key="method.call.deprecated" value="Method ''{0}'' has been deprecated" />
			<message key="type.call.deprecated" value="Type ''{0}'' has been deprecated" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.EnumConstantDividerCheck">
			<message key="empty.line.unnecessary" value="Unnecessary empty line needed between enum constants" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.EnumConstantOrderCheck">
			<message key="enum.constant.incorrect.order" value="Enum constant ''{0}'' should come after constant ''{1}''" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.ExceptionCheck">
			<property name="enabled" value="false" />
			<message key="exception.unnecessary" value="Method ''{0}'' throws unnecessary {1}. All methods calling ''{0}'' throw ''Exception''." />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.ExceptionMessageCheck">
			<message key="message.incorrect" value="Incorrect exception message" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.ExceptionVariableNameCheck">
			<property name="enabled" value="false" />
			<message key="variable.rename" value="Rename exception variable ''{0}'' to ''{1}''" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.FactoryCheck">
			<message key="factory.use" value="Use ''{0}'' to create new instance of ''{1}''" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.FilterStringWhitespaceCheck">
			<message key="whitespace.incorrect" value="The value of ''{0}'' should not have spaces around ''='', see LPS-70526" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.FrameworkBundleCheck">
			<property name="category" value="Performance" />
			<property name="description" value="Checks that `org.osgi.framework.Bundle.getHeaders()` is not used" />
			<message key="bundle.get.headers.use" value="Use ''Bundle.getHeaders(java.lang.String locale)'' statement instead ''Bundle.getHeaders()''" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.FullyQualifiedNameCheck">
			<message key="import.statement.use" value="Use import statement instead of Fully Qualified Name for ''{0}'" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.GenericTypeCheck">
			<property name="enabled" value="false" />
			<property name="populateTypeNames" value="false" />
			<message key="generic.type.parameterize" value="Parameterize the generic {0} for ''{1}'" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.InstanceofOrderCheck">
			<message key="instanceof.order" value="''{0}'' should come before ''{1}''" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.ItemListBuilderCheck">
			<property name="checkInline" value="true" />
			<property name="enabled" value="false" />
			<message key="builder.include" value="Include method call ''{0}'' ({1}) in ''{2}'' ({3})" />
			<message key="builder.inline" value="Inline variable definition ''{0}'' ({1}) inside ''{2}'' ({3})" />
			<message key="builder.use" value="Use ''{0}'' ({1}, {2})" />
			<message key="builder.use.instead" value="Use ''{0}'' instead of new instance of ''{1}''" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.JavadocCheck">
			<message key="javadoc.empty.line" value="First or last line in javadoc should not be empty" />
			<message key="javadoc.incorrect.first.line" value="Javadoc should start with ''/**''" />
			<message key="javadoc.incorrect.last.line" value="Javadoc should end with ''*/''" />
			<message key="javadoc.multiple" value="''{0}'' has multiple javadocs" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.JSONNamingCheck">
			<message key="variable.name.reserved" value="{0} name ending with ''{1}'' is reserved for object ''{2}''" />
			<message key="variable.rename" value="Rename {0} ''{1}'' to ''{2}''" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.JSONUtilCheck">
			<property name="category" value="Styling" />
			<property name="description" value="Checks for utilization of class `JSONUtil`" />
			<message key="json.util.put.all.use" value="Use ''JSONUtil.putAll'' instead of chaining on ''JSONUtil.put''" />
			<message key="json.util.put.use" value="Combine calls ''{0}'' ({1}) and ''{2}'' ({3}) into single call ''{4}''" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.LambdaCheck">
			<property name="category" value="Styling" />
			<property name="description" value="Checks that `lambda` statements are as simple as possible" />
			<message key="lambda.simplify" value="Simplify lambda statement with single statement" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.LineBreakAfterCommaCheck">
			<message key="line.break.incorrect" value="There should be a line break after ''{0}''" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.LineBreakBeforeGenericStartCheck">
			<message key="line.break.incorrect" value="There should be a line break after ''{0}''" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.LineEndCharacterCheck">
			<message key="end.line.character.incorrect" value="Line should not end with ''{0}''" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.ListUtilCheck">
			<property name="category" value="Styling" />
			<property name="description" value="Checks for utilization of class `ListUtil`" />
			<message key="array.unneeded" value="Pass arguments directly to ''ListUtil.fromArray'' instead of passing new array" />
			<message key="list.util.use" value="Use ''ListUtil.fromArray'' to simplify code" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.LiteralStringEqualsCheck">
			<message key="objects.equals.use.1" value="Use ''Objects.equals'' instead of calling ''equals'' on a literal String" />
			<message key="objects.equals.use.2" value="Either use ''{0}'' or use ''Objects.equals'' if ''{1}'' can have a ''null'' value, instead of calling ''equals'' on a literal String" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.LocalPatternCheck">
			<message key="pattern.local" value="Create a global variable for Pattern ''{0}''" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.LogMessageCheck">
			<message key="message.incorrect" value="Incorrect log message" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.LPS42924Check">
			<message key="lps42924" value="Use ''classNameLocalService.getClassNameId'' instead of ''PortalUtil.getClassName''" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.MapBuilderCheck">
			<property name="checkInline" value="true" />
			<property name="enabled" value="false" />
			<message key="builder.include" value="Include method call ''{0}'' ({1}) in ''{2}'' ({3})" />
			<message key="builder.inline" value="Inline variable definition ''{0}'' ({1}) inside ''{2}'' ({3})" />
			<message key="builder.use" value="Use ''{0}'' ({1}, {2})" />
			<message key="builder.use.instead" value="Use ''{0}'' instead of new instance of ''{1}''" />
			<message key="null.value.incorrect" value="Null values are not allowed in ''{0}''" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.MapIterationCheck">
			<property name="category" value="Performance" />
			<property name="description" value="Checks that there are no unnecessary map iterations" />
			<message key="entry.set.use" value="Use Map.entrySet() to retrieve values" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.MethodNamingCheck">
			<message key="method.rename" value="Rename method ''{0}'' to ''{1}''" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.MissingAuthorCheck">
			<message key="author.missing" value="Missing author" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.MissingDeprecatedJavadocCheck">
			<message key="javadoc.missing.deprecated" value="Must include both @java.lang.Deprecated annotation and @deprecated Javadoc tag with description" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.MissingDiamondOperatorCheck">
			<property name="enforceDiamondOperatorClassNames" value="" />
			<message key="diamond.operator.missing" value="Missing diamond operator ''&lt;&gt;'' for type ''{0}''" />
			<message key="generic.types.missing" value="Missing generic types ''{0}'' for type ''{1}''" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.MissingEmptyLineCheck">
			<property name="category" value="Styling" />
			<property name="description" value="Checks for missing line breaks around variable declarations" />
			<message key="empty.line.missing.after.method.call" value="There should be an empty line after line ''{0}''" />
			<message key="empty.line.missing.after.method.name" value="There should be an empty line after ''{0}''" />
			<message key="empty.line.missing.after.variable.definition" value="There should be an empty line after variable definition of type ''{0}''" />
			<message key="empty.line.missing.after.variable.reference" value="There should be an empty line before line ''{0}'', as we finished referencing variable ''{1}''" />
			<message key="empty.line.missing.before.variable.assign" value="There should be an empty line before assigning value to variable ''{0}''" />
			<message key="empty.line.missing.before.variable.use" value="There should be an empty line between assigning and using variable ''{0}''" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.MissingModifierCheck">
			<message key="modifier.missing" value="Missing modifier for ''{0}''" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.MissingOverrideCheck">
			<property name="enabled" value="false" />
			<message key="override.missing" value="Missing @Override" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.MissingParenthesesCheck">
			<message key="parentheses.missing.1" value="Missing parentheses between the ''{0}'' operator and the ''{1}'' operator" />
			<message key="parentheses.missing.2" value="Missing parentheses around the {0} hand side argument of the ''{1}'' operator" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.NestedIfStatementCheck">
			<message key="if.statements.combine" value="Combine nested if-statements" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.NotRequireThisCheck">
			<message key="variable.not.require.this" value="Reference to variable ''{0}'' does not need ''.this''" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.NumberSuffixCheck">
			<message key="suffix.incorrect" value="Use uppercase ''{0}'' as suffix for the type ''{1}''" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.OperatorOperandCheck">
			<property name="enabled" value="false" />
			<message key="readability.improve" value="Create a new variable for the {0} hand side operand of the ''{1}'' operator for better readability" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.OperatorOrderCheck">
			<message key="left.argument.literal.or.num" value="''{0}'' should be on the right hand side of the operator" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.ParsePrimitiveTypeCheck">
			<message key="getter.util.method.use" value="Use ''GetterUtil.{0}'' or properly catch ''NumberFormatException'' when calling ''{1}.{2}''" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.PersistenceCallCheck">
			<message key="persistence.call.illegal" value="Illegal call to class ''{0}'', see LPS-68923" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.PersistenceUpdateCheck">
			<property name="category" value="Bug Prevention" />
			<property name="description" value="Checks that there are no stale references in service code from persistence updates" />
			<message key="update.call.reassign" value="Update call should be reassigned to variable ''{0}''" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.PlusStatementCheck">
			<message key="end.character.invalid" value="When concatenating multiple literal strings using '+', only the last literal string can end with ''{0}''" />
			<message key="literal.string.combine" value="Combine the literal strings ''{0}'' and ''{1}''" />
			<message key="literal.string.move" value="Add the string ''{0}'' to the previous literal string" />
			<message key="start.character.invalid" value="When concatenating multiple literal strings using '+', only the first literal string can start with ''{0}''" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.RedundantBranchingStatementCheck">
			<message key="branching.statement.redundant" value="Redundant ''{0}'' statement" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.ReferenceAnnotationCheck">
			<message key="default.unbind.redundant" value="No need to specify default ''unbind'' method. See https://osgi.org/javadoc/r4v43/cmpn/org/osgi/service/component/annotations/Reference.html#unbind()" />
			<message key="reference.move" value="Move @Reference from method ''{0}'' to field ''{1}''" />
			<message key="unbind.dynamic.policy.missing" value="Always specify a valid ''unbind'' method when using ''policy = ReferencePolicy.DYNAMIC'' policy. See https://osgi.org/javadoc/r4v43/cmpn/org/osgi/service/component/annotations/Reference.html#unbind()" />
			<message key="unbind.static.policy.missing" value="Specify ''unbind'' method. Use ''unbind = {0}'' when ''unbind'' method is not needed. See https://osgi.org/javadoc/r4v43/cmpn/org/osgi/service/component/annotations/Reference.html#unbind()" />
			<message key="volatile.missing" value="Variable ''{0}'' should be volatile" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.SelfReferenceCheck">
			<message key="self.reference.unneeded" value="Reference to method ''{0}'' does not need ''{1}''" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.SemiColonCheck">
			<message key="semi.colon.unnecessary" value="Unnecessary semi colon" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.SingleStatementClauseCheck">
			<message key="braces.missing" value="Use braces around {0}-statement clause" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.SizeIsZeroCheck">
			<message key="method.use" value="Use method ''{0}'' instead" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.StaticBlockCheck">
			<property name="immutableFieldTypes" value="boolean,byte,char,double,float,int,long,short,Boolean,Byte,Character,Class,Double,Float,Int,Long,Number,Short,String" />
			<message key="static.block.unneeded" value="No need to use static block for method call ''{0}''" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.StringBundlerNamingCheck">
			<property name="category" value="Naming Conventions" />
			<property name="description" value="Checks for consistent naming on variables of type 'StringBundler'" />
			<message key="variable.name.incorrect" value="StringBundler {0} ''{1}'' should end with either ''sb'' or ''SB''" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.StringCastCheck">
			<message key="string.cast.unneeded" value="No need to call ''.toString()'' on type String" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.TernaryOperatorCheck">
			<message key="ternary.operator.avoid" value="Use if-else-statement instead of ternary conditional operator for better readability" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.TestClassCheck">
			<message key="test.base.class.invalidName" value="Base test class ''{0}'' should start with ''Base''" />
			<message key="test.case.class.incorrect.abstract" value="Class ending in *TestCase should be abstract. Either make the class abstract or rename to ''{0}'' if the class contains actual tests" />
			<message key="test.class.incorrect.abstract" value="Test class ''{0}'' should not be abstract" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.ThreadLocalUtilCheck">
			<message key="thread.local.util.use" value="Use ''ThreadLocalUtil.create'' when initializing variable ''{0}''" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.ThreadNameCheck">
			<message key="thread.rename" value="Rename thread to ''{0}''" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.TransactionalTestRuleCheck">
			<message key="import.invalid" value="Avoid using import TransactionalTestRule in *StagedModelDataHandlerTest, see LPS-68908" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.TryWithResourcesCheck">
			<property name="enabled" value="false" />
			<property name="populateTypeNames" value="false" />
			<message key="try.with.resources.use" value="Use Try-With-Resources statement to declare ''{0}'' instead of closing the resource in the ''finally'' statement using ''{1}''" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.UnnecessaryAssignCheck">
			<message key="assign.unnecessary.before.reassign" value="No need to assign call to variable ''{0}'', because ''{0}'' is reassigned another value without being used" />
			<message key="assign.unnecessary.before.return" value="No need to assign call to variable ''{0}'', because ''{0}'' is returned right after" />
			<message key="assign.unnecessary.unused" value="No need to assign call to variable ''{0}'', because ''{0}'' is not used after the call" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.UnnecessaryTypeCastCheck">
			<message key="type.cast.unnecessary" value="No need to apply Type Cast to method ''{0}''" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.UnnecessaryVariableDeclarationCheck">
			<message key="variable.declaration.unnecessary.before.reassign" value="No need to declare variable ''{0}'' because ''{0}'' is reassigned another value without being used" />
			<message key="variable.declaration.unnecessary.before.return" value="No need to declare variable ''{0}'' because it is returned right after" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.UnprocessedExceptionCheck">
			<message key="exception.unprocessed" value="Unprocessed exception ''{0}'', see LPS-36174" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.UnusedMethodCheck">
			<property name="allowedMethodNames" value="readObject,writeObject" />
			<message key="method.unused" value="Method ''{0}'' is unused" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.UnusedParameterCheck">
			<message key="parameter.unused" value="Parameter ''{0}'' is unused" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.UnusedVariableCheck">
			<message key="variable.unused" value="Variable ''{0}'' is unused" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.UnwrappedVariableInfoCheck">
			<message key="variable.info.unwrapped" value="Wrap the variable ''{0}'' into an inner class ''Concealer'' in order to defer array elements initialization, see LPS-72768" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.ValidatorIsNullCheck">
			<message key="method.invalidName" value="Avoid using method ''{0}''" />
			<message key="method.reserved" value="Method ''{0}'' should only be used for type ''Long'', ''Serializable'' or ''String''" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.VariableDeclarationAsUsedCheck">
			<message key="variable.declaration.not.needed" value="No need to declare variable ''{0}''. Pass the method call directly as parameter on line ''{1}''." />
			<message key="variable.declare.as.used" value="For better performance, the variable declaration for ''{0}'' should come after the ''{1}'' statement on line ''{2}''" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.VariableNameCheck">
			<property name="allowedVariableNames" value="bitMode,metadata,superClass,userName" />
			<property name="enabled" value="false" />
			<property name="enforceTypeNames" value=".*(In|Out)putStream,DetailAST,(Double|Int|Long)Stream,Enumeration,HttpServlet(Request|Response),Iterator,LiferayPortlet(Request|Response),NamedList,Object,OrderByComparator,Query,QueryPos,RenderRequest,RenderResponse,ServletRequest,ServletResponse,SQLQuery,UnicodeProperties,Unsync.*" />
			<message key="variable.incorrect.ending" value="Name of variable with type ''{0}'' should end with ''{1}''" />
			<message key="variable.rename" value="Rename variable ''{0}'' to ''{1}''" />
			<message key="variable.typo" value="Typo in variable ''{0}'', expected variable name ''{1}''" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.WhitespaceAfterParameterAnnotationCheck">
			<message key="whitespace.missing" value="Whitespace is expected after ''{0}''" />
		</module>
		<module name="com.liferay.source.formatter.checkstyle.checks.WhitespaceAroundGenericsCheck">
			<message key="whitespace.missing" value="Whitespace is expected after ''{0}''" />
			<message key="whitespace.redundant" value="Incorrect whitespace before ''{0}''" />
		</module>
	</module>
</module>




© 2015 - 2024 Weber Informatics LLC | Privacy Policy