source-formatter.properties

##
## Exclusions
##

    #
    # Input a list of comma delimited paths that will be excluded by the source
    # formatter.
    #
    source.formatter.excludes=\
        **/.cache/**,\
        **/.git/**,\
        **/.gradle/**,\
        **/.task-cache/**,\
        **/bin/**,\
        **/bower_components/**,\
        **/build/**,\
        **/bundles/**,\
        **/classes/**,\
        **/liferay-theme.json,\
        **/modules/apps/collaboration/blogs/blogs-service/src/main/java/com/liferay/blogs/service/impl/BlogsEntryLocalServiceImpl.java,\
        **/modules/apps/foundation/portal-remote/portal-remote-axis-extender-test/src/testIntegration/java/com/liferay/portal/remote/axis/extender/test/service/http/**,\
        **/modules/apps/knowledge-base/knowledge-base-web/src/main/resources/META-INF/resources/display/configuration.jsp,\
        **/modules/apps/sync/sync-web/docroot/WEB-INF/src/com/liferay/sync/service/impl/SyncPreferencesLocalServiceImpl.java,\
        **/modules/sdk/ant-bnd/src/test/resources/com/liferay/ant/bnd/jsp/dependencies/*.jsp,\
        **/modules/sdk/gradle-templates/src/main/resources/**,\
        **/modules/util/portal-tools-service-builder/src/main/resources/jalopy.xml,\
        **/node_modules/**,\
        **/portal-impl/src/portal-ext.properties,\
        **/test-classes/**,\
        **/test-coverage/**,\
        **/test-results/**,\
        **/tmp/**,\
        **/tools/sdk/**,\
        **/tools/tck/**,\
        **/webapps/**

    #
    # Input a list of comma delimited paths that should be ignored when doing
    # specific checks for field types, like proper naming or checking for
    # finalable, mutable, or staticable field types.
    #
    check.java.field.types.excludes=\
        modules/apps/sync/sync-engine/src/main/java/com/liferay/sync/engine/session/Session.java,\
        modules/apps/wsrp/wsrp-portlet/docroot/WEB-INF/src/com/liferay/wsrp/proxy/Stub.java,\
        modules/util/portal-tools-service-builder/src/main/java/com/liferay/portal/tools/service/builder/ServiceBuilder.java,\
        portal-impl/src/com/liferay/portal/events/EventsProcessorUtil.java,\
        portal-impl/src/com/liferay/portal/template/AbstractTemplate.java,\
        portal-impl/test/unit/com/liferay/portal/json/One.java,\
        portal-impl/test/unit/com/liferay/portal/json/Two.java,\
        portal-impl/test/unit/com/liferay/portal/nio/intraband/proxy/IntrabandProxyUtilTest.java,\
        portal-kernel/src/com/liferay/portal/kernel/io/PathHolder.java

    #
    # Input a list of comma delimited paths that should be ignored when checking
    # for correct tabbing.
    #
    check.tabs.excludes=\
        portal-impl/test/unit/com/liferay/portal/nio/intraband/proxy/IntrabandProxyUtilTest.java

    #
    # Input a list of comma delimited paths that should be ignored when applying
    # diamond operators.
    #
    diamond.operator.excludes=\
        **/ant-beanshell/**,\
        **/ant-bnd/**,\
        **/org-gradle/**,\
        **/osgi-util/**,\
        modules/core/registry-impl/src/main/java/com/liferay/registry/internal/RegistryImpl.java,\
        portal-impl/src/com/liferay/portal/jsonwebservice/JSONWebServiceActionsManagerImpl.java,\
        portal-impl/src/com/liferay/portlet/messageboards/util/MBMailMessage.java,\
        portal-kernel/src/com/liferay/portal/kernel/repository/BaseRepositoryImpl.java,\
        portal-kernel/src/com/liferay/portal/kernel/search/generic/BooleanClauseFactoryImpl.java,\
        portal-kernel/src/com/liferay/portal/kernel/util/ListUtil.java

    #
    # Input a list of comma delimited paths that should be ignored when trying
    # to fit multiple lines on single line.
    #
    fit.on.single.line.excludes=\
        portal-impl/test/integration/com/liferay/portal/xmlrpc/XmlRpcParserTest.java

    #
    # Input a list of comma delimited paths that are allowed to call
    # session.createSQLQuery instead of session.createSynchronizedSQLQuery. See
    # LPS-42599.
    #
    hibernate.sql.query.excludes=

    #
    # Input a list of comma delimited paths that are allowed to have Java terms
    # without an access level modifier specified.
    #
    javaterm.access.level.modifier.excludes=\
        portal-impl/test/unit/com/liferay/portal/nio/intraband/proxy/IntrabandProxyUtilTest.java,\
        portal-kernel/test/unit/com/liferay/portal/kernel/annotation/AnnotationLocatorTest.java,\
        portal-kernel/test/unit/com/liferay/portal/kernel/resiliency/spi/agent/annotation/DistributedRegistryTest.java

    #
    # Input a list of comma delimited paths that are allowed to have
    # unalphabetized Java terms. In addition these paths are allowed to have
    # nonfinal variables that are capitalized.
    #
    javaterm.sort.excludes=\
        modules/apps/sync/sync-engine/src/main/java/com/liferay/sync/engine/service/persistence/**,\
        modules/apps/web-experience/journal/journal-service/src/main/java/com/liferay/journal/transformer/RegexTransformerUtil.java@_log,\
        portal-impl/src/com/liferay/portal/util/PortalImpl.java@_logWebServerServlet,\
        portal-kernel/src/com/liferay/portal/kernel/log/LogFactoryUtil.java@_logFactory,\
        portal-kernel/src/com/liferay/portal/kernel/model/ListTypeConstants.java,\
        portal-kernel/src/com/liferay/portal/kernel/portlet/UserAttributes.java,\
        portal-kernel/src/com/liferay/portal/kernel/servlet/HttpHeaders.java,\
        portal-kernel/src/com/liferay/portal/kernel/util/JavaDetector.java@_log,\
        portal-kernel/src/com/liferay/portal/kernel/util/ReleaseInfo.java,\
        tools/servers/tcat/LiferayDeployerFactory.groovy

    #
    # Input a list of comma delimited JSP paths that are allowed to have
    # variables that are not used by other files in portal. These variable are
    # used by plugins.
    #
    jsp.unused.variables.excludes=\
        portal-web/docroot/html/taglib/ui/social_bookmark/init.jsp@20

    #
    # Input a list of comma delimited paths that are allowed to surpass the 80
    # column limit.
    #
    line.length.excludes=\
        modules/apps/collaboration/blogs/blogs-test/src/testIntegration/java/com/liferay/blogs/subscription/test/BlogsSubscriptionRootContainerModelTest.java,\
        modules/apps/collaboration/item-selector/item-selector-editor-configuration/src/main/java/com/liferay/item/selector/editor/configuration/internal/BaseEditorConfigContributor.java@34,\
        modules/apps/collaboration/wiki/wiki-test/src/testIntegration/java/com/liferay/wiki/subscription/test/WikiSubscriptionContainerModelTest.java,\
        modules/apps/collaboration/wiki/wiki-test/src/testIntegration/java/com/liferay/wiki/trash/test/WikiPageDependentsTrashHandlerTest.java,\
        modules/apps/collaboration/wiki/wiki-test/src/testIntegration/java/com/liferay/wiki/trash/test/WikiPageTrashHandlerTest.java@185,\
        modules/apps/forms-and-workflow/dynamic-data-mapping/dynamic-data-mapping-api/src/main/java/com/liferay/dynamic/data/mapping/exception/RequiredDataProviderInstanceException.java,\
        modules/apps/forms-and-workflow/dynamic-data-mapping/dynamic-data-mapping-api/src/main/java/com/liferay/dynamic/data/mapping/util/DDMFormLayoutFactoryHelper.java,\
        modules/apps/forms-and-workflow/dynamic-data-mapping/dynamic-data-mapping-service/src/main/java/com/liferay/dynamic/data/mapping/service/impl/DDMDataProviderInstanceLocalServiceImpl.java@108,\
        modules/apps/forms-and-workflow/dynamic-data-mapping/dynamic-data-mapping-service/src/main/java/com/liferay/dynamic/data/mapping/util/impl/DDMBeanTranslatorImpl.java,\
        modules/apps/foundation/configuration-admin/configuration-admin-web/src/main/java/com/liferay/configuration/admin/web/internal/portlet/action/ExportConfigurationMVCResourceCommand.java@141,\
        modules/apps/foundation/portal-configuration/portal-configuration-extender/src/testIntegration/java/com/liferay/portal/configuration/extender/internal/test/ConfiguratorExtensionTest.java@218,\
        modules/apps/foundation/portal-configuration/portal-configuration-extender/src/testIntegration/java/com/liferay/portal/configuration/extender/internal/test/ConfiguratorExtensionTest.java@300,\
        modules/apps/foundation/portal-configuration/portal-configuration-metatype-definitions-annotations/src/main/java/com/liferay/portal/configuration/metatype/definitions/annotations/internal/AnnotationsExtendedObjectClassDefinition.java@37,\
        modules/apps/foundation/portal-security/portal-security-ldap/src/main/java/com/liferay/portal/security/ldap/internal/configuration/LDAPServerConfigurationProviderImpl.java@412,\
        modules/apps/foundation/portal-template/portal-template-freemarker/src/main/java/com/liferay/portal/template/freemarker/configuration/FreeMarkerEngineConfiguration.java@52,\
        modules/apps/web-experience/export-import/export-import-api/src/main/java/com/liferay/exportimport/portlet/preferences/processor/ExportImportPortletPreferencesProcessorRegistryUtil.java,\
        modules/apps/web-experience/export-import/export-import-test/src/testIntegration/java/com/liferay/exportimport/test/LayoutSetPrototypePropagationTest.java@258,\
        modules/apps/web-experience/journal/journal-service/src/main/java/com/liferay/journal/configuration/JournalServiceConfigurationKeys.java,\
        modules/apps/web-experience/journal/journal-service/src/main/java/com/liferay/journal/configuration/JournalServiceConfigurationValues.java,\
        modules/apps/web-experience/product-navigation/product-navigation-control-menu-api/src/main/java/com/liferay/product/navigation/control/menu/util/ProductNavigationControlMenuCategoryRegistry.java@124,\
        modules/core/osgi-service-tracker-collections/src/testIntegration/java/com/liferay/osgi/service/tracker/collections/map/test/ObjectServiceTrackerMapTest.java@414,\
        modules/util/lang-builder/src/main/java/com/liferay/lang/builder/LangBuilder.java@573,\
        modules/util/lang-builder/src/main/java/com/liferay/lang/builder/LangBuilder.java@581,\
        modules/util/pmd/src/main/java/com/liferay/pmd/rules/java/OverrideBothEqualsAndHashcodeRule.java@28,\
        modules/util/portal-tools-service-builder/src/main/java/com/liferay/portal/tools/service/builder/ServiceBuilder.java,\
        portal-impl/src/com/liferay/portal/fabric/netty/client/NettyFabricClientConfig.java@69,\
        portal-impl/src/com/liferay/portal/spring/hibernate/PortalHibernateConfiguration.java@260,\
        portal-impl/src/com/liferay/portal/tools/WebXML23Converter.java@81,\
        portal-impl/src/com/liferay/portal/util/PortalImpl.java@545,\
        portal-impl/src/com/liferay/portal/util/WebKeys.java,\
        portal-impl/test/integration/com/liferay/portal/editor/configuration/EditorConfigContributorTest.java,\
        portal-impl/test/integration/com/liferay/portal/editor/configuration/EditorConfigTransformerTest.java,\
        portal-impl/test/integration/com/liferay/portal/service/PortletPreferencesLocalServiceTest.java,\
        portal-impl/test/integration/com/liferay/portal/util/PortalImplCanonicalURLTest.java,\
        portal-impl/test/integration/com/liferay/portal/util/PortalImplLocalizedFriendlyURLTest.java,\
        portal-impl/test/integration/com/liferay/portlet/documentlibrary/service/DLFileEntryExtensionTest.java@314,\
        portal-impl/test/integration/com/liferay/portlet/documentlibrary/service/DLFileEntryExtensionTest.java@336,\
        portal-impl/test/integration/com/liferay/portlet/documentlibrary/service/persistence/DLFileEntryFinderTest.java,\
        portal-kernel/src/com/liferay/portal/kernel/model/ListTypeConstants.java@53,\
        portal-kernel/src/com/liferay/portal/kernel/model/ListTypeConstants.java@72,\
        portal-kernel/src/com/liferay/portal/kernel/model/ListTypeConstants.java@105,\
        portal-kernel/src/com/liferay/portal/kernel/model/impl/VirtualLayout.java@207,\
        portal-kernel/src/com/liferay/portal/kernel/model/impl/VirtualLayout.java@211,\
        portal-kernel/src/com/liferay/portal/kernel/search/QueryConfig.java@379,\
        portal-kernel/src/com/liferay/portal/kernel/util/PropsKeys.java,\
        portal-kernel/src/com/liferay/portal/kernel/util/WebKeys.java,\
        portal-kernel/test/unit/com/liferay/portal/kernel/concurrent/ThreadPoolExecutorTest.java@234,\
        portal-test/src/com/liferay/portal/kernel/test/rule/TransactionalTestRule.java@188,\
        portal-test-integration/src/com/liferay/portlet/subscriptions/test/BaseSubscriptionContainerModelTestCase.java,\
        portal-test-integration/src/com/liferay/portlet/subscriptions/test/BaseSubscriptionRootContainerModelTestCase.java,\
        portal-test-integration/src/com/liferay/portlet/trash/test/BaseTrashHandlerTestCase.java

    #
    # Input a list of comma delimited portlet XML paths that are allowed to have
    # non-numerical portlet-name elements.
    #
    numerical.portlet.name.element.excludes=\
        portal-impl/src/com/liferay/portal/deploy/dependencies/liferay-portlet.xml

    #
    # Input a list of comma delimited paths that are allowed to use
    # java.lang.reflect.Proxy.
    #
    proxy.excludes=\
        modules/apps/foundation/portal-template/portal-template-freemarker/src/main/java/com/liferay/portal/template/freemarker/internal/FreeMarkerManager.java,\
        modules/apps/static/portal-osgi-web/portal-osgi-web-servlet-jsp-compiler/src/main/java/com/liferay/portal/osgi/web/servlet/jsp/compiler/JspServlet.java,\
        portal-kernel/src/com/liferay/portal/kernel/util/ProxyUtil.java

    #
    # Input a list of comma delimited paths that are allowed to run outside the
    # portal. For files that match any of these paths, we skip source formatting
    # rules that enforce calling portal methods.
    #
    run.outside.portal.excludes=\
        **/ant-bnd/**,\
        **/gradle-plugins-maven-plugin-builder/**,\
        **/gradle-plugins-node/**,\
        **/gradle-util/**,\
        **/markdown-converter/**,\
        **/osgi-util/**,\
        **/portal-osgi-web-wab-extender/**,\
        **/portal-target-platform-indexer/**,\
        **/portal-tools-data-partitioning-sql-builder/**,\
        **/registry-api/**,\
        **/sync-engine/**,\
        modules/test/poshi-runner/src/main/java/com/liferay/poshi/runner/util/GetterUtil.java,\
        portal-kernel/src/com/liferay/portal/kernel/util/GetterUtil.java

    #
    # Input a list of comma delimited paths that are allowed to use
    # java.io.ObjectInputStream directly. See LPS-60358.
    #
    secure.deserialization.excluded.files=\
        portal-impl/src/com/liferay/portal/bean/BeanPropertiesImpl.java,\
        portal-kernel/src/com/liferay/portal/kernel/io/AnnotatedObjectInputStream.java,\
        portal-kernel/src/com/liferay/portal/kernel/io/ProtectedObjectInputStream.java,\
        portal-kernel/src/com/liferay/portal/kernel/process/local/LocalProcessExecutor.java,\
        portal-kernel/src/com/liferay/portal/kernel/process/local/LocalProcessLauncher.java,\
        portal-kernel/src/com/liferay/portal/kernel/util/ClassLoaderObjectInputStream.java,\
        portal-kernel/src/com/liferay/portal/kernel/util/ClassLoaderProxy.java

    #
    # Input a list of comma delimited paths that are allowed to use
    # java.security.SecureRandom. See LPS-39508.
    #
    secure.random.excludes=\
        portal-kernel/src/com/liferay/portal/kernel/security/SecureRandomUtil.java,\
        portal-kernel/test/unit/com/liferay/portal/kernel/security/SecureRandomUtilTest.java

    #
    # Input a list of comma delimited paths that are allowed to use JAXB and
    # JAXP directly. See LPS-50479.
    #
    secure.xml.excludes=\
        modules/apps/foundation/petra/petra-log4j/src/main/java/com/liferay/petra/log4j/Log4JUtil.java,\
        modules/apps/foundation/portal/portal-monitoring/src/main/java/com/liferay/portal/monitoring/internal/MonitoringGateKeeper.java,\
        modules/apps/static/petra/petra-xml/src/main/java/com/liferay/petra/xml/Dom4jUtil.java,\
        modules/apps/static/portal-osgi-web/portal-osgi-web-servlet-context-helper/src/main/java/com/liferay/portal/osgi/web/servlet/context/helper/internal/definition/WebXMLDefinitionLoader.java,\
        modules/apps/static/portal-target-platform-indexer/portal-target-platform-indexer/src/main/java/com/liferay/portal/target/platform/indexer/internal/DefaultIndexValidator.java,\
        modules/apps/web-experience/xsl-content/xsl-content-web/src/main/java/com/liferay/xsl/content/web/internal/util/XSLContentUtil.java,\
        modules/private/apps/spi/spi-provider-web/docroot/WEB-INF/src/com/liferay/portal/resiliency/spi/provider/tomcat/TomcatRemoteSPI.java,\
        modules/sdk/ant-bnd/src/main/java/com/liferay/ant/bnd/social/SocialAnalyzerPlugin.java,\
        modules/sdk/gradle-plugins-maven-plugin-builder/src/main/java/com/liferay/gradle/plugins/maven/plugin/builder/util/XMLUtil.java,\
        portal-impl/src/com/liferay/portal/security/xml/SecureXMLFactoryProviderImpl.java,\
        portal-impl/src/com/liferay/portal/tools/JavadocBuilder.java,\
        portal-impl/src/com/liferay/portal/tools/PluginsEnvironmentBuilder.java,\
        portal-impl/src/com/liferay/portal/tools/ToolDependencies.java,\
        portal-impl/src/com/liferay/portal/util/MimeTypesImpl.java,\
        portal-impl/src/com/liferay/portal/xml/SAXReaderFactory.java,\
        util-java/src/com/liferay/util/ant/Java2WsddTask.java,\
        util-java/src/com/liferay/util/log4j/Log4JUtil.java,\
        util-java/src/com/liferay/util/xml/Dom4jUtil.java,\
        util-java/src/com/liferay/util/xml/XMLMergerRunner.java

    #
    # Input a list of comma delimited paths that are allowed to have nonstatic
    # _log variables.
    #
    static.log.excludes=\
        modules/core/portal-security-pacl/src/main/java/com/liferay/portal/security/pacl/jndi/PACLInitialContextFactory.java,\
        modules/core/portal-security-pacl/src/main/java/com/liferay/portal/security/pacl/jndi/PACLInitialContextFactoryBuilder.java,\
        portal-impl/src/com/liferay/portal/servlet/filters/BasePortalFilter.java,\
        portal-kernel/src/com/liferay/portal/kernel/log/LogWrapper.java

    #
    # Input a list of comma delimited paths that are excluded when checking for
    # correct use of test annotations.
    #
    test.annotations.excludes=

    #
    # Input a list of comma delimited upgrade paths that are allowed to call
    # ServiceUtil methods. See LPS-34911.
    #
    upgrade.service.util.excludes=\
        portal-impl/src/com/liferay/portal/upgrade/v6_0_12_to_6_1_0/UpgradePermission.java,\
        portal-impl/src/com/liferay/portal/upgrade/v6_1_0/UpgradeImageGallery.java,\
        portal-impl/src/com/liferay/portal/upgrade/v6_1_0/UpgradePermission.java

    #
    # Input a list of comma delimited upgrade and verify paths that are allowed
    # to call DataAccess.getUpgradeOptimizedConnection. See LPS-65213.
    #
    upgrade.data.access.connection.excludes=\
        portal-impl/src/com/liferay/portal/upgrade/util/BaseUpgradeTableImpl.java,\
        portal-impl/src/com/liferay/portal/upgrade/util/UpgradeCompanyId.java,\
        portal-impl/src/com/liferay/portal/verify/VerifyProcess.java,\
        portal-kernel/src/com/liferay/portal/kernel/upgrade/BaseUpgradeCompanyId.java,\
        portal-kernel/src/com/liferay/portal/kernel/upgrade/UpgradeProcess.java,\
        portal-kernel/src/com/liferay/portal/kernel/upgrade/util/UpgradeProcessUtil.java

    #
    # Input a list of comma delimited XML paths that are allowed to have lines
    # that start with spaces.
    #
    xml.excludes=\
        definitions/web-facesconfig_1_2.xml,\
        portal-web/docroot/dtd/web-facesconfig_1_2.xml

##
## General Source Formatting
##

    #
    # Set this property to true to allow *ServiceImpl classes to directly call
    # methods in *ServiceUtil classes.
    #
    allow.use.service.util.in.service.impl=false

    #
    # Specify incorrect and expected parameters for the methods LanguageUtil.get
    # and LanguageUtil.format. See LPS-47682.
    #
    languageutil.expected.parameter=request
    languageutil.incorrect.parameter=pageContext

    #
    # Set this property to true to move frequently used imports to
    # common/init.jsp.
    #
    move.frequently.used.imports.to.common.init=true

    #
    # Set this property to true to add the release version to deprecated Java
    # terms.
    #
    add.missing.deprecation.release.version=true

##
## Immutable Field Types
##

    #
    # Input a list of comma delimited field types that are immutable. This list
    # will be appended to the following default immutable field types:
    # boolean, byte, char, double, float, int, long, short, java.lang.Boolean,
    # java.lang.Byte, java.lang.Character, java.lang.Class, java.lang.Double,
    # java.lang.Float, java.lang.Int, java.lang.Long, java.lang.Number,
    # java.lang.Short, java.lang.String.
    #
    immutable.field.types=