om.liferay.source.formatter.1.0.1457.source-code.checkstyle.xml Maven / Gradle / Ivy
The 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="annotation/annotationusestyle.html" />
</module>
<module name="ArrayTypeStyleCheck">
<property name="category" value="Styling" />
<property name="description" value="Checks the style of array type definitions." />
<property name="documentationLocation" value="misc/arraytypestyle.html" />
</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="blocks/avoidnestedblocks.html" />
</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="imports/avoidstarimport.html" />
</module>
<module name="DefaultComesLastCheck">
<property name="category" value="Styling" />
<property name="description" value="Checks that the `default` is after all the cases in a `switch` statement." />
<property name="documentationLocation" value="coding/defaultcomeslast.html" />
</module>
<module name="EqualsHashCodeCheck">
<property name="category" value="Bug Prevention" />
<property name="description" value="Checks that classes that either override `equals()` or `hashCode()` also overrides the other." />
<property name="documentationLocation" value="coding/equalshashcode.html" />
</module>
<module name="JavadocStyleCheck">
<property name="category" value="Javadoc" />
<property name="checkFirstSentence" value="false" />
<property name="description" value="Validates Javadoc comments to help ensure they are well formed." />
<property name="documentationLocation" value="javadoc/javadocstyle.html" />
</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="naming/localfinalvariablename.html" />
<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="naming/localvariablename.html" />
<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="naming/membername.html" />
<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="naming/membername.html" />
<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="naming/methodname.html" />
<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="naming/methodname.html" />
<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="whitespace/methodparampad.html" />
</module>
<module name="MissingDeprecatedCheck">
<property name="category" value="Bug Prevention" />
<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="annotation/missingdeprecated.html" />
</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="modifier/modifierorder.html" />
</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="coding/multiplevariabledeclarations.html" />
</module>
<module name="NeedBracesCheck">
<property name="allowEmptyLoopBody" value="true" />
<property name="category" value="Styling" />
<property name="description" value="Checks for braces around code blocks." />
<property name="documentationLocation" value="blocks/needbraces.html" />
</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="whitespace/nolinewrap.html" />
</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="whitespace/nowhitespaceafter.html" />
<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="whitespace/nowhitespacebefore.html" />
</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="coding/onestatementperline.html" />
</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="whitespace/operatorwrap.html" />
<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="naming/packagename.html" />
</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="naming/parametername.html" />
<property name="format" value="^[a-z][_a-zA-Z0-9]*$" />
<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="coding/requirethis.html" />
</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="naming/staticvariablename.html" />
<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="naming/staticvariablename.html" />
<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="coding/stringliteralequality.html" />
</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="naming/typename.html" />
<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="coding/unnecessaryparentheses.html" />
</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="whitespace/whitespaceafter.html" />
<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="whitespace/whitespacearound.html" />
</module>
<!-- Custom checks -->
<module name="com.liferay.source.formatter.checkstyle.check.AccessModifierCheck">
<property name="category" value="Bug Prevention" />
<property name="description" value="Checks for cases where visibility of methods can be decreased." />
<message key="access.modifier.incorrect" value="Access modifier of method "{0}" should be private" />
<property name="enabled" value="false" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.AnonymousClassCheck">
<property name="category" value="Bug Prevention" />
<property name="description" value="Checks for serialization issue when using anonymous class." />
<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.check.AppendCheck">
<property name="category" value="Styling" />
<property name="description" value="Checks instances where literal Strings are appended." />
<property name="enabled" value="false" />
<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 {1} 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}"" />
<message key="string.combine" value="Combine the literal string "{0}" with "{1}"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.ArquillianCheck">
<property name="category" value="Bug Prevention" />
<property name="description" value="Checks for correct use of `com.liferay.arquillian.extension.junit.bridge.junit.Arquillian`." />
<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.check.ArrayUtilCheck">
<property name="category" value="Styling" />
<property name="description" value="Checks for utilization of class `ArrayUtil`." />
<property name="enabled" value="false" />
<message key="array.util.is.empty.use" value="Use "ArrayUtil.isEmpty({0})" to simplify code" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.AssertEqualsCheck">
<property name="category" value="Styling" />
<property name="description" value="Checks that additional information is provided when calling `Assert.assertEquals`." />
<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." />
<message key="assert.use.boolean" value="Use "Assert.assert{0}" instead of "Assert.assertEquals" when assert boolean" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.AssertFailCheck">
<property name="category" value="Bug Prevention" />
<property name="description" value="Checks that calls to `Assert.fail` can be only used inside a try block as the last statement." />
<message key="assert.fail.avoid" value=""Assert.fail" can be only used inside a try block as the last statement" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.AssignAsUsedCheck">
<property name="category" value="Performance" />
<property name="description" value="Finds cases where an assign statement can be inlined or moved closer to where it is used." />
<message key="string.value.of.use" value="Simplify by using "String.valueOf" (combining the statement on line "{0}" and "toString()" on line "{1}")" />
<message key="to.string.add" value="Simplify by adding "toString()" to the chain on line "{0}"" />
<message key="variable.inline" value="No need to assign variable "{0}". Pass the {1} directly as parameter on line "{2}"." />
<message key="variable.move.after.branching.statement" value="For better performance, the variable assignment for "{0}" should come after the "{1}" statement on line "{2}"" />
<message key="variable.move.inside.if.statement" value="For better performance, the variable assignment for "{0}" should be moved inside the {1}-statement on line "{2}"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.BrandNameCheck">
<property name="category" value="Naming Conventions" />
<property name="description" value="Checks the correct brand name." />
<property name="enabled" value="false" />
<message key="rename" value="Rename {0} "{1}" to "{2}"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.CamelCaseNameCheck">
<property name="category" value="Naming Conventions" />
<property name="description" value="Checks variable names for correct use of `CamelCase`." />
<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.check.CapsNameCheck">
<property name="category" value="Naming Conventions" />
<property name="description" value="Checks the correct caps name." />
<property name="enabled" value="false" />
<message key="rename" value="Rename {0} "{1}" to "{2}"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.ChainingCheck">
<property name="applyToTypeCast" value="true" />
<property name="category" value="Styling" />
<property name="description" value="Checks that method chaining can be used when possible." />
<message key="chaining.avoid.parentheses" value="Avoid chaining on expressions with parentheses" />
<message key="chaining.avoid.type.cast" value="Avoid chaining on Type Cast" />
<message key="chaining.required" value="Chaining on "{0}" is preferred" />
<message key="response.unsorted" value="Method calls between "Response.status" and "Response.build" should be sorted" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.ClassNameIdCheck">
<property name="category" value="Bug Prevention" />
<property name="description" value="Avoid caching noncompany scoped class name IDs." />
<property name="enabled" value="false" />
<message key="variable.name.avoid" value="Avoid using variable name "{0}", see LPD-29718" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.CompanyIterationCheck">
<property name="category" value="Bug Prevention" />
<property name="description" value="Checks that `CompanyLocalService.forEachCompany` or `CompanyLocalService.forEachCompanyId` is used when iterating over companies." />
<property name="enabled" value="false" />
<message key="company.local.service.use.for.loop" value="Use "CompanyLocalService.{0}" when iterating over "{1}"" />
<message key="company.local.service.use.sql" value="Use "CompanyLocalService.forEachCompany" instead of SQL" />
<message key="portal.instances.use" value="Use "PortalInstancePool.getCompanyIds" instead to fetch company IDs" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.ComponentAnnotationCheck">
<property name="category" value="Bug Prevention" />
<property name="description" value="Performs several checks on classes with @Component annotation." />
<message key="configuration.policy.incorrect" value="Always specify "configurationPolicy = ConfigurationPolicy.REQUIRE" when a class extends "BaseAuthVerifierPipelineConfigurator"" />
<message key="configuration.policy.unnecessary" value="Remove "configurationPolicy = {0}" as it is unnecessary" />
<message key="osgi.jaxrs.name.incorrect" value="The value of "osgi.jaxrs.name" should end with "{0}"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.ComponentExposureCheck">
<property name="category" value="Bug Prevention" />
<property name="description" value="Avoid exposing static component." />
<property name="enabled" value="false" />
<message key="static.component.exposed" value="Do not expose private static field "{0}"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.ConcatCheck">
<property name="category" value="Performance" />
<property name="description" value="Checks for correct use of `StringBundler.concat`." />
<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 {1} 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}"" />
<message key="string.combine" value="Combine the literal string "{0}" with "{1}"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.ConstantNameCheck">
<property name="camelCaseTypeNames" value="AggregateTestRule,Atomic.*,CodeCoverageAssertor,LiferayIntegrationTestRule,Log,Pattern,TestRule" />
<property name="category" value="Naming Conventions" />
<property name="description" value="Checks that variable names of constants follow correct naming rules." />
<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.check.ConstructorGlobalVariableDeclarationCheck">
<property name="category" value="Performance" />
<property name="description" value="Checks that initial values of global variables are not set in the constructor." />
<property name="enabled" value="false" />
<message key="global.variable.value.declare" value="Set the value of "{0}" when declaring the variable on line "{1}"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.ConstructorMissingEmptyLineCheck">
<property name="category" value="Styling" />
<property name="description" value="Checks for line breaks when assigning variables in constructor." />
<message key="empty.line.missing" value="There should be an empty line before line "{0}"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.ConsumerTypeAnnotationCheck">
<property name="category" value="Bug Prevention" />
<property name="description" value="Performs several checks on classes with @ConsumerType annotation." />
<message key="default.annotation.redundant" value="No need to specify default "ConsumerType" annotation. See https://docs.osgi.org/javadoc/osgi.annotation/8.0.0/org/osgi/annotation/versioning/ConsumerType.html" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.ContractionsCheck">
<property name="category" value="Styling" />
<property name="description" value="Finds contractions in Strings (such as `can't` or `you're`)." />
<message key="contraction.avoid" value="Avoid using contraction "{0}"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.CreationMenuBuilderCheck">
<property name="category" value="Miscellaneous" />
<property name="checkInline" value="true" />
<property name="description" value="Checks that `CreationMenuBuilder` is used when possible." />
<property name="enforceBuilderNames" value="" />
<message key="builder.include" value="Include method call "{0}" ({1}) in "{2}" ({3})" />
<message key="builder.inline.1" value="Inline variable definition "{0}" ({1}) inside "{2}" ({3}), possibly by using a lambda function" />
<message key="builder.inline.2" value="Inline variable definition "{0}" ({1}) and dependent statements ({2}) inside "{3}" ({4}) by using a lambda function" />
<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.check.DatabaseMetaDataCheck">
<property name="category" value="Bug Prevention" />
<property name="description" value="Checks usages of `java.sql.DatabaseMetaData`." />
<property name="enabled" value="false" />
<message key="replace.get.index.info" value="Use the method "com.liferay.portal.kernel.dao.db.DB#getIndexResult()" instead of "{0}.getIndexInfo()"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.DeprecatedAPICheck">
<property name="category" value="Bug Prevention" />
<property name="description" value="Finds calls to deprecated classes, constructors, fields or methods." />
<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.check.DTOEnumCreationCheck">
<property name="category" value="Bug Prevention" />
<property name="description" value="Checks the creation of DTO enum." />
<message key="create.use" value="Use "create" to create DTO enum, instead of "valueOf"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.EmptyConstructorCheck">
<property name="category" value="Bug Prevention" />
<property name="description" value="Finds unnecessary empty constructors." />
<property name="enabled" value="false" />
<message key="empty.constructor.unneeded" value="Empty constructor is not needed" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.EnumConstantDividerCheck">
<property name="category" value="Styling" />
<property name="description" value="Find unnecessary empty lines between enum constants." />
<message key="empty.line.unnecessary" value="Unnecessary empty line needed between enum constants" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.EnumConstantOrderCheck">
<property name="category" value="Styling" />
<property name="description" value="Checks the order of enum constants." />
<message key="enum.constant.incorrect.order" value="Enum constant "{0}" should come after constant "{1}"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.EqualClauseIfStatementsCheck">
<property name="category" value="Styling" />
<property name="description" value="Finds consecutive if-statements with identical clauses." />
<property name="enabled" value="false" />
<message key="if.statements.combine" value="Combine if-statements with identical clauses" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.ExceptionCheck">
<property name="category" value="Performance" />
<property name="description" value="Finds private methods that throw unnecessary exception." />
<message key="exception.unnecessary" value="Method "{0}" throws unnecessary {1}. All methods calling "{0}" throw "Exception"." />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.ExceptionMessageCheck">
<property name="category" value="Styling" />
<property name="description" value="Validates messages that are passed to exceptions." />
<message key="message.incorrect" value="Incorrect exception message" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.ExceptionPrintStackTraceCheck">
<property name="category" value="Bug Prevention" />
<property name="description" value="Avoid using printStackTrace." />
<message key="method.call.avoid" value="Avoid using method "printStackTrace"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.ExceptionVariableNameCheck">
<property name="category" value="Naming Conventions" />
<property name="description" value="Validates variable names that have type `*Exception`." />
<message key="variable.rename" value="Rename exception variable "{0}" to "{1}"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.FactoryCheck">
<property name="category" value="Bug Prevention" />
<property name="description" value="Finds cases where `*Factory` should be used when creating new instances of an object." />
<message key="factory.use" value="Use "{0}" to create new instance of "{1}"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.FilterStringWhitespaceCheck">
<property name="category" value="Bug Prevention" />
<property name="description" value="Finds missing and unnecessary whitespace in the value of the filter string in `ServiceTrackerFactory.open` or `WaiterUtil.waitForFilter`." />
<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.check.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.check.FullyQualifiedNameCheck">
<property name="category" value="Miscellaneous" />
<property name="description" value="Finds cases where a Fully Qualified Name is used instead of importing a class." />
<message key="import.statement.use" value="Use import statement instead of Fully Qualified Name for "{0}"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.GenericTypeCheck">
<property name="category" value="Bug Prevention" />
<property name="description" value="Checks that generics are always specified to provide compile-time checking and removing the risk of `ClassCastException` during runtime." />
<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.check.InnerExceptionClassCheck">
<property name="category" value="Bug Prevention" />
<property name="description" value="Checks that classes that should have either public constructors or inner classes." />
<property name="enabled" value="false" />
<message key="class.definition.incorrect" value="Exception class should have either public constructors or inner classes" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.InstanceInitializerCheck">
<property name="category" value="Styling" />
<property name="description" value="Performs several checks on class instance initializer." />
<property name="enabled" value="false" />
<message key="assign.move.before.method.call" value="The variable assignment for "{0}" should come before the method calling "{1}"" />
<message key="assign.order.incorrect" value="The variable assignment for "{0}" should come before the variable assignment for "{1}"" />
<message key="method.call.order.incorrect" value="The method calling "{0}" should come before the method calling "{1}"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.InstanceofOrderCheck">
<property name="category" value="Styling" />
<property name="description" value="Check the order of `instanceof` calls." />
<message key="instanceof.order" value=""{0}" should come before "{1}"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.ItemBuilderCheck">
<property name="category" value="Miscellaneous" />
<property name="checkInline" value="true" />
<property name="description" value="Checks that `DropdownItemBuilder`, `LabelItemBuilder` or `NavigationItemBuilder` is used when possible." />
<property name="enforceBuilderNames" value="" />
<message key="builder.include" value="Include method call "{0}" ({1}) in "{2}" ({3})" />
<message key="builder.inline.1" value="Inline variable definition "{0}" ({1}) inside "{2}" ({3}), possibly by using a lambda function" />
<message key="builder.inline.2" value="Inline variable definition "{0}" ({1}) and dependent statements ({2}) inside "{3}" ({4}) by using a lambda function" />
<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.check.ItemListBuilderCheck">
<property name="category" value="Miscellaneous" />
<property name="checkInline" value="true" />
<property name="description" value="Checks that `DropdownItemListBuilder`, `LabelItemListBuilder` or `NavigationItemListBuilder` is used when possible." />
<property name="enforceBuilderNames" value="" />
<message key="builder.include" value="Include method call "{0}" ({1}) in "{2}" ({3})" />
<message key="builder.inline.1" value="Inline variable definition "{0}" ({1}) inside "{2}" ({3}), possibly by using a lambda function" />
<message key="builder.inline.2" value="Inline variable definition "{0}" ({1}) and dependent statements ({2}) inside "{3}" ({4}) by using a lambda function" />
<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.check.JavadocCheck">
<property name="category" value="Javadoc" />
<property name="description" value="Performs several checks on javadoc." />
<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.check.JSONNamingCheck">
<property name="category" value="Naming Conventions" />
<property name="description" value="Checks if variable names follow naming conventions." />
<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.check.JSONPortletResponseUtilCheck">
<property name="category" value="Styling" />
<property name="description" value="Checks if `JSONPortletResponseUtil.writeJSON ` should come before method calling `hideDefaultSuccessMessage`." />
<message key="method.call.move.before.method.call" value=""JSONPortletResponseUtil.writeJSON" should come before the method calling "hideDefaultSuccessMessage"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.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}"" />
<message key="json.util.to.string.use.1" value="Use "toString" instead of "String.valueOf"" />
<message key="json.util.to.string.use.2" value="Use "toString" instead of "toJSONString"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.LambdaCheck">
<property name="category" value="Styling" />
<property name="description" value="Checks that `lambda` statements are as simple as possible." />
<message key="lambda.simplify.1" value="Simplify lambda statement with single statement" />
<message key="lambda.simplify.2" value="Simplify lambda statement with method reference" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.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.from.array.use" value="Use "ListUtil.fromArray" to simplify code" />
<message key="list.util.is.empty.use" value="Use "ListUtil.isEmpty({0})" to simplify code" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.LiteralStringEqualsCheck">
<property name="category" value="Styling" />
<property name="description" value="Finds cases where `Objects.equals` should be used." />
<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.check.LocalPatternCheck">
<property name="category" value="Performance" />
<property name="description" value="Checks that a `java.util.Pattern` variable is declared globally, so that it is initiated only once." />
<message key="pattern.local" value="Create a global variable for Pattern "{0}"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.LogMessageCheck">
<property name="category" value="Styling" />
<property name="description" value="Validates messages that are passed to `log.*` calls." />
<message key="message.incorrect" value="Incorrect log message" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.LPS42924Check">
<property name="category" value="Bug Prevention" />
<property name="description" value="Finds cases where `PortalUtil.getClassName*` (instead of calling `classNameLocalService` directly)." />
<message key="lps42924" value="Use "classNameLocalService.getClassNameId" instead of "PortalUtil.getClassName"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.MapBuilderCheck">
<property name="category" value="Miscellaneous" />
<property name="checkInline" value="true" />
<property name="description" value="Checks that `ConcurrentHashMapBuilder`, `HashMapBuilder`, `LinkedHashMapBuilder` or `TreeMapBuilder` is used when possible." />
<property name="enforceBuilderNames" value="" />
<message key="builder.include" value="Include method call "{0}" ({1}) in "{2}" ({3})" />
<message key="builder.inline.1" value="Inline variable definition "{0}" ({1}) inside "{2}" ({3}), possibly by using a lambda function" />
<message key="builder.inline.2" value="Inline variable definition "{0}" ({1}) and dependent statements ({2}) inside "{3}" ({4}) by using a lambda function" />
<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.check.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.check.MethodEqualsCheck">
<property name="category" value="Styling" />
<property name="description" value="Finds cases where `Objects.equals` should be used." />
<message key="objects.equals.use" value="Use "Objects.equals" instead of calling "equals" on method" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.MethodNamingCheck">
<property name="category" value="Naming Conventions" />
<property name="checkSearchMethodNames" value="false" />
<property name="description" value="Checks that method names follow naming conventions." />
<message key="method.incorrect.ending" value="Name of method returning type "{0}" should end with "{1}"" />
<message key="method.rename" value="Rename method "{0}" to "{1}"" />
<message key="search.method.incorrect" value="Incorrect name of method "{0}". Name should equal "search" or start with "searchBy"." />
<message key="set.safe.closeable.method.incorrect" value="Incorrect name of method "{0}". Name should include a word of context between "set" and "WithSafeCloseable"." />
<property name="enforceTypeNames" value="" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.MissingAuthorCheck">
<property name="category" value="Javadoc" />
<property name="description" value="Finds classes that have no `@author` specified." />
<message key="author.missing" value="Missing author" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.MissingDeprecatedJavadocCheck">
<property name="category" value="Javadoc" />
<property name="description" value="Verifies that the annotation @Deprecated and the Javadoc tag @deprecated are both present when either of them is present." />
<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.check.MissingDiamondOperatorCheck">
<property name="category" value="Bug Prevention" />
<property name="description" value="Checks for missing diamond operator for types that require diamond operator." />
<property name="enforceDiamondOperatorClassNames" value="" />
<message key="diamond.operator.missing" value="Missing diamond operator "<>" for type "{0}"" />
<message key="generic.types.missing" value="Missing generic types "{0}" for type "{1}"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.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.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.method.name" value="There should be an empty line before "{0}"" />
<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}"" />
<message key="empty.line.missing.line.number" value="There should be an empty line {0} line "{1}"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.MissingModifierCheck">
<property name="category" value="Bug Prevention" />
<property name="description" value="Verifies that a method or global variable has a modifier specified." />
<message key="modifier.missing" value="Missing modifier for "{0}"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.MissingParenthesesCheck">
<property name="category" value="Styling" />
<property name="description" value="Finds missing parentheses in conditional statement." />
<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.check.ModifiedMethodCheck">
<property name="category" value="Bug Prevention" />
<property name="description" value="Checks for incorrect `modified` method with `@Modified` annotation." />
<property name="enabled" value="false" />
<message key="modified.method.incorrect" value="Remove method "modified" as it only calls "deactivate" and then "activate"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.MVCCommandNameCheck">
<property name="category" value="Naming Conventions" />
<property name="description" value="Checks for consistent naming for values of `mvc.command.name`." />
<message key="value.incorrect" value="Incorrect value "{0}" for "mvc.command.name"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.NestedFieldAnnotationCheck">
<property name="category" value="Bug Prevention" />
<property name="description" value="Checks for `nested.field.support` in the `property` attribute of the `Component` annotation." />
<property name="enabled" value="false" />
<message key="nested.field.support.missing" value="Set "nested.field.support=true" in the "property" attribute of "Component" annotation as one of methods has a "NestedField" annotation" />
<message key="nested.field.support.unneeded" value="Remove "nested.field.support" in the "property" attribute of "Component" annotation as no method has a "NestedField" annotation" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.NestedIfStatementCheck">
<property name="category" value="Styling" />
<property name="description" value="Finds nested if statements that can be combined." />
<message key="if.statements.combine" value="Combine nested if-statements" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.NotRequireThisCheck">
<property name="category" value="Styling" />
<property name="description" value="Finds cases of unnecessary use of `this.`." />
<message key="variable.not.require.this" value="Reference to variable "{0}" does not need ".this"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.NullAssertionInIfStatementCheck">
<property name="category" value="Bug Prevention" />
<property name="description" value="Verifies that null check should always be first in if-statement." />
<message key="null.check.move" value="Null check for variable "{0}" should always be first in if-statement" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.NumberSuffixCheck">
<property name="category" value="Styling" />
<property name="description" value="Verifies that uppercase `D`, `F`, or `L` is used when denoting Double/Float/Long." />
<message key="suffix.incorrect" value="Use uppercase "{0}" as suffix for the type "{1}"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.OperatorOperandCheck">
<property name="category" value="Styling" />
<property name="description" value="Verifies that operand do not go over too many lines and make the operator hard to read." />
<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.check.OperatorOrderCheck">
<property name="category" value="Styling" />
<property name="description" value="Verifies that when an operator has a literal string or a number as one of the operands, it is always on the right hand side." />
<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.check.OSGiCommandsCheck">
<property name="category" value="Bug Prevention" />
<property name="description" value="Perform several checks on `*OSGiCommands` classes." />
<property name="enabled" value="false" />
<message key="bad.class.name" value="The names of clases that implement OSGi commands must end with "OSGiCommands"" />
<message key="bad.osgi.reference" value="OSGi references to `*OSGiCommands` classes are not allowed" />
<message key="missing.command.function" value="OSGi command "{0}" is missing a method that implements it" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.OSGiResourceBuilderCheck">
<property name="category" value="Styling" />
<property name="description" value="Avoid using *Resource.builder." />
<message key="method.call.avoid" value="Avoid using method "*Resource.builder" in OSGi component" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.ParsePrimitiveTypeCheck">
<property name="category" value="Performance" />
<property name="description" value="Verifies that `GetterUtil.parse*` is used to parse primitive types, when possible." />
<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.check.PersistenceCallCheck">
<property name="category" value="Bug Prevention" />
<property name="description" value="Finds illegal persistence calls across component boundaries." />
<message key="persistence.call.illegal" value="Illegal call to class "{0}", see LPS-68923" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.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.check.PlusStatementCheck">
<property name="category" value="Styling" />
<property name="description" value="Performs several checks to statements where `+` is used for concatenation." />
<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 {1} literal string" />
<message key="start.character.invalid" value="When concatenating multiple literal strings using "+", only the first literal string can start with "{0}"" />
<message key="string.combine" value="Combine the literal string "{0}" with "{1}"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.PortletURLBuilderCheck">
<property name="category" value="Miscellaneous" />
<property name="checkInline" value="true" />
<property name="description" value="Checks that `PortletURLBuilder` is used when possible." />
<property name="enforceBuilderNames" value="" />
<message key="build.string.use" value="No need to call "{0}.toString", use "buildString" instead of "{1}"" />
<message key="builder.include" value="Include method call "{0}" ({1}) in "{2}" ({3})" />
<message key="builder.inline.1" value="Inline variable definition "{0}" ({1}) inside "{2}" ({3}), possibly by using a lambda function" />
<message key="builder.inline.2" value="Inline variable definition "{0}" ({1}) and dependent statements ({2}) inside "{3}" ({4}) by using a lambda function" />
<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="if.statement.inline" value="Inline if-statement inside "{0}" ({1}) using a lambda function" />
<message key="keyword.reserved" value="Do not use "{0}" to set parameter "{1}", use "{2}" instead" />
<message key="string.cast.unneeded" value="No need to cast parameter to "String" when passing to method "{0}"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.RedundantBranchingStatementCheck">
<property name="category" value="Performance" />
<property name="description" value="Finds unnecessary branching (`break`, `continue` or `return`) statements." />
<message key="branching.statement.redundant" value="Redundant "{0}" statement" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.RedundantLogCheck">
<property name="category" value="Performance" />
<property name="description" value="Finds unnecessary logs." />
<property name="enabled" value="false" />
<message key="log.redundant" value="Redundant log between line "{0}" and line "{1}"." />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.ReferenceAnnotationCheck">
<property name="category" value="Bug Prevention" />
<property name="description" value="Performs several checks on classes with @Reference annotation." />
<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="dynamic.policy.missing" value="When using "cardinality = ReferenceCardinality.OPTIONAL" and "policyOption = ReferencePolicyOption.GREEDY", always use "policy = ReferencePolicy.DYNAMIC" as well" />
<message key="reference.move" value="Move @Reference from method "{0}" to field "{1}"" />
<message key="snapshot.use" value="Use Snapshot instead of "cardinality = ReferenceCardinality.OPTIONAL", see LPS-184625" />
<message key="target.value.incorrect" value="Do not use "target = {0}"" />
<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.check.ResourceImplCheck">
<property name="category" value="Bug Prevention" />
<property name="description" value="Performs several checks on `*ResourceImpl` classes (except `Base*ResourceImpl` classes)." />
<property name="enabled" value="false" />
<message key="invalid.method.parameter.annotation" value="Remove annotation "{0}" from method parameter "{1}"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.ResourcePermissionCheck">
<property name="category" value="Bug Prevention" />
<property name="checkModelClassName" value="true" />
<property name="description" value="Performs several checks on `*ResourcePermission` classes." />
<property name="enabled" value="false" />
<message key="model.class.name.mismatch" value="Expected `model.class.name` property value to be "{0}" but is "{1}"" />
<message key="model.class.name.missing" value="The `model.class.name` property is missing from the @Component annotation" />
<message key="remove.service.ranking.property" value="Remove property "{0}" from the @Component annotation" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.ResourcePermissionFactoryCheck">
<property name="category" value="Performance" />
<property name="description" value="Checks usage of `*ResourcePermissionFactory` classes." />
<property name="enabled" value="false" />
<message key="deprecated.get.instance.usage" value="Do not use "{0}". Use @Reference instead" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.RESTDTOSetCallCheck">
<property name="category" value="Performance" />
<property name="description" value="Ensures using set calls with `UnsafeSupplier` parameter for REST DTO." />
<property name="enabled" value="false" />
<message key="if.statement.inline" value="Use "{0}(UnsafeSupplier)" with inlined if-statement" />
<message key="set.method.use.instead" value="Use "{0}(UnsafeSupplier)" instead" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.ReturnVariableDeclarationAsUsedCheck">
<property name="category" value="Miscellaneous" />
<property name="description" value="Finds cases where a variable declaration should be moved." />
<property name="enabled" value="false" />
<message key="empty.line.missing.after.variable.definition" value="There should be an empty line after variable definition on line "{0}"" />
<message key="variable.declaration.move" value="Move the variable declaration for "{0}" on line "{1}"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.SelfReferenceCheck">
<property name="category" value="Bug Prevention" />
<property name="description" value="Finds cases of unnecessary reference to its own class." />
<message key="self.reference.unneeded" value="Reference to method "{0}" does not need "{1}"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.SemiColonCheck">
<property name="category" value="Styling" />
<property name="description" value="Finds cases of unnecessary semicolon." />
<message key="semi.colon.unnecessary" value="Unnecessary semi colon" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.ServiceComponentRuntimeCheck">
<property name="category" value="Bug Prevention" />
<property name="description" value="Checks `ServiceComponentRuntime` usage in test classes." />
<property name="enabled" value="false" />
<message key="promise.get.value" value="Must wait for "Promise" from "{0}" to complete. Assign the promise to a variable and call its "getValue()" method" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.ServiceProxyFactoryCheck">
<property name="category" value="Bug Prevention" />
<property name="description" value="Finds incorrect parameter in method call." />
<message key="parameter.incorrect" value="Pass "{0}" as the second parameter when calling method "ServiceProxyFactory.newServiceTrackedInstance"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.ServiceUpdateCheck">
<property name="category" value="Bug Prevention" />
<property name="description" value="Checks that there are no stale references in service code from service updates." />
<property name="enabled" value="false" />
<message key="update.call.reassign" value="Update call should be reassigned to variable "{0}"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.SizeIsZeroCheck">
<property name="category" value="Styling" />
<property name="description" value="Finds cases of calls like `list.size() == 0` (use `list.isEmpty()` instead)." />
<message key="method.use" value="Use method "{0}" instead" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.StaticBlockCheck">
<property name="category" value="Bug Prevention" />
<property name="description" value="Performs several checks on static blocks." />
<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.check.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.check.StringCastCheck">
<property name="category" value="Performance" />
<property name="description" value="Finds cases where a redundant `toString()` is called on variable type `String`." />
<message key="string.cast.unneeded" value="No need to call ".toString()" on type String" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.SystemEventCheck">
<property name="category" value="Bug Prevention" />
<property name="description" value="Finds missing or redundant usage of @SystemEvent for delete events." />
<property name="enabled" value="false" />
<message key="system.event.missing" value="Missing "@SystemEvent(type = SystemEventConstants.TYPE_DELETE)" for method "{0}"" />
<message key="system.event.unneeded.1" value="@SystemEvent on method "{0}" is not needed, because the first parameter is not "{1}"" />
<message key="system.event.unneeded.2" value="@SystemEvent on method "{0}" is not needed, because "{1}" does not implement "ClassedModel"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.TernaryOperatorCheck">
<property name="category" value="Styling" />
<property name="description" value="Finds use of ternary operator in `java` files (use if statement instead)." />
<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.check.TestClassCheck">
<property name="category" value="Naming Conventions" />
<property name="description" value="Checks that names of test classes follow naming conventions." />
<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.check.TestClassMissingLiferayUnitTestRuleCheck">
<property name="category" value="Bug Prevention" />
<property name="description" value="Finds missing LiferayUnitTestRule." />
<message key="test.rule.missing" value="Missing test rule "LiferayUnitTestRule"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.ThreadContextClassLoaderCheck">
<property name="category" value="Bug Prevention" />
<property name="description" value="Checks usage of `Thread.setContextClassLoader`." />
<property name="enabled" value="false" />
<message key="thread.context.class.loader.util.use" value="Use "ThreadContextClassLoaderUtil.swap()" instead to swap the context class loader of the current thread" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.ThreadLocalUtilCheck">
<property name="category" value="Performance" />
<property name="description" value="Finds new instances of `java.lang.Thread` (use `ThreadLocalUtil.create` instead)." />
<message key="thread.local.util.use" value="Use "ThreadLocalUtil.create" when initializing variable "{0}"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.ThreadNameCheck">
<property name="category" value="Naming Conventions" />
<property name="description" value="Checks that names of threads follow naming conventions." />
<message key="thread.rename" value="Rename thread to "{0}"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.TransactionalTestRuleCheck">
<property name="category" value="Bug Prevention" />
<property name="description" value="Finds usage of `TransactionalTestRule` in `*StagedModelDataHandlerTest`." />
<message key="import.invalid" value="Avoid using import TransactionalTestRule in *StagedModelDataHandlerTest, see LPS-68908" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.TryWithResourcesCheck">
<property name="category" value="Performance" />
<property name="description" value="Ensures using Try-With-Resources statement to properly close the resource." />
<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.check.UnicodePropertiesBuilderCheck">
<property name="category" value="Miscellaneous" />
<property name="checkInline" value="true" />
<property name="description" value="Checks that `UnicodePropertiesBuilder` is used when possible." />
<property name="enforceBuilderNames" value="" />
<message key="builder.include" value="Include method call "{0}" ({1}) in "{2}" ({3})" />
<message key="builder.inline.1" value="Inline variable definition "{0}" ({1}) inside "{2}" ({3}), possibly by using a lambda function" />
<message key="builder.inline.2" value="Inline variable definition "{0}" ({1}) and dependent statements ({2}) inside "{3}" ({4}) by using a lambda function" />
<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.check.UnnecessaryAssignCheck">
<property name="category" value="Performance" />
<property name="description" value="Finds unnecessary assign statements (when it is either reassigned or returned right after)." />
<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.to.string" value="No need to assign call to variable "{0}", use String.valueOf() to combine line "{1}" and "{2}"" />
<message key="assign.unnecessary.unused" value="No need to assign call to variable "{0}", because "{0}" is not used after the call" />
<message key="list.assign.unnecessary.before.return" value="No need to assign List variable "{0}" before return, use "ListUtil.fromArray()" instead" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.UnnecessaryMethodCallCheck">
<property name="category" value="Styling" />
<property name="description" value="Finds unnecessary method calls." />
<message key="method.call.unnecessary" value="Use "{0}" instead of calling method "{1}"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.UnnecessaryTypeCastCheck">
<property name="category" value="Performance" />
<property name="description" value="Finds unnecessary Type Casting." />
<message key="type.cast.unnecessary" value="No need to apply Type Cast to method "{0}"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.UnnecessaryVariableDeclarationCheck">
<property name="category" value="Performance" />
<property name="description" value="Finds unnecessary variable declarations (when it is either reassigned or returned right after)." />
<message key="list.declaration.unnecessary.before.return" value="No need to declare List variable "{0}" before return, use "ListUtil.fromArray()" instead" />
<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" />
<message key="variable.declaration.unnecessary.to.string" value="No need to declare variable "{0}", use String.valueOf() to combine line "{1}" and "{2}"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.UnprocessedExceptionCheck">
<property name="category" value="Performance" />
<property name="description" value="Finds cases where an `Exception` is swallowed without being processed." />
<property name="enabled" value="false" />
<message key="exception.unprocessed" value="Unprocessed exception "{0}", see LPS-36174" />
<message key="missing.debug.log.json.exception" value="Missing debug logging for "JSONException"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.UnusedMethodCheck">
<property name="allowedMethodNames" value="readObject,writeObject" />
<property name="category" value="Performance" />
<property name="description" value="Finds private methods that are not used." />
<message key="method.unused" value="Method "{0}" is unused" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.UnusedParameterCheck">
<property name="category" value="Performance" />
<property name="description" value="Finds parameters in private methods that are not used." />
<message key="parameter.unused" value="Parameter "{0}" is unused" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.UnusedVariableCheck">
<property name="category" value="Performance" />
<property name="description" value="Finds variables that are declared, but not used." />
<message key="variable.unused" value="Variable "{0}" is unused" />
<message key="variable.value.unused" value="Value of variable "{0}" is unused" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.UnwrappedVariableInfoCheck">
<property name="category" value="Bug Prevention" />
<property name="description" value="Finds cases where the variable should be wrapped into an inner class in order to defer array elements initialization." />
<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.check.UpgradeDeprecatedAPICheck">
<property name="category" value="Upgrade" />
<property name="description" value="Finds calls to deprecated classes, constructors, fields or methods after an upgrade." />
<message key="constructor.call.deprecated" value="Constructor "{0}" has been deprecated in version "{1}"" />
<message key="field.call.deprecated" value="Field "{0}" has been deprecated in version "{1}"" />
<message key="method.call.deprecated" value="Method "{0}" has been deprecated in version "{1}"" />
<message key="type.call.deprecated" value="Type "{0}" has been deprecated in version "{1}"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.UpgradeProcessCheck">
<property name="category" value="Performance" />
<property name="description" value="Performs several checks on `*UpgradeProcess` classes." />
<property name="enabled" value="false" />
<message key="class.unnecessary" value="No need to create "{0}" class. Replace it by inline calls to the "UpgradeProcessFactory" class in the registrator class" />
<message key="if.statement.unnecessary" value="No need to use if-statement to wrap "alterColumn*" and "alterTable*" calls" />
<message key="upgrade.step.move.inside.post.upgrade.steps" value="Move "{0}" call inside "getPostUpgradeSteps" method" />
<message key="upgrade.step.move.inside.pre.upgrade.steps" value="Move "{0}" call inside "getPreUpgradeSteps" method" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.UpgradeRemovedAPICheck">
<property name="category" value="Upgrade" />
<property name="description" value="Finds cases where calls are made to removed API after an upgrade." />
<message key="class.not.found.1" value="Class "{0}" no longer exists, or has been moved, in version "{1}"" />
<message key="class.not.found.2" value="Class "{0}" no longer exists in version "{1}", possible changed to "{2}"" />
<message key="class.not.found.3" value="Class "{0}" no longer exists in version "{1}", possible changed to one of the following: {2}" />
<message key="constructor.not.found" value="Constructor for "{0}" no longer exists, or the signature has changed, in version "{1}"" />
<message key="method.not.found" value="Method "{0}" no longer exists, or the signature has changed, in class "{1}" for version "{2}"" />
<message key="variable.not.found" value="Variable "{0}" no longer exists in class "{1}" for version "{2}"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.URLInputStreamCheck">
<property name="category" value="Bug Prevention" />
<property name="description" value="Checks usages of `URL.openStream()`." />
<property name="enabled" value="false" />
<message key="replace.usage" value="Use method "{0}" instead of "{1}"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.ValidatorIsNullCheck">
<property name="category" value="Bug Prevention" />
<property name="description" value="Ensures that only variable of type `Long`, `Serializable` or `String` is passed to method `com.liferay.portal.kernel.util.Validator.isNull`." />
<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.check.VariableDeclarationAsUsedCheck">
<property name="category" value="Performance" />
<property name="description" value="Finds cases where a variable declaration can be inlined or moved closer to where it is used." />
<message key="string.value.of.use" value="Simplify by using "String.valueOf" (combining the statement on line "{0}" and "toString()" on line "{1}")" />
<message key="to.string.add" value="Simplify by adding "toString()" to the chain on line "{0}"" />
<message key="variable.inline" value="No need to declare variable "{0}". Pass the {1} directly as parameter on line "{2}"." />
<message key="variable.move.after.branching.statement" value="For better performance, the variable declaration for "{0}" should come after the "{1}" statement on line "{2}"" />
<message key="variable.move.inside.if.statement" value="For better performance, the variable declaration for "{0}" should be moved inside the {1}-statement on line "{2}"" />
</module>
<module name="com.liferay.source.formatter.checkstyle.check.VariableNameCheck">
<property name="allowedVariableNames" value="bitMode,metadata,superClass,userName" />
<property name="category" value="Naming Conventions" />
<property name="description" value="Checks that variable names follow naming conventions." />
<property name="enforceTypeNames" value="" />
<message key="variable.incorrect.count" value="Rename variable "{0}" to "{1}" (and increment counts for other variables "{0}*")" />
<message key="variable.incorrect.ending" value="Name of variable with type "{0}" should end with "{1}"" />
<message key="variable.name.incorrect.for.statement" value="Use format "curVariableName" for variable "{0}"" />
<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>
</module> © 2015 - 2024 Weber Informatics LLC | Privacy Policy