source-formatter.properties

##
## Exclusions
##

    #
    # Input a list of comma delimited paths that will be excluded by the source
    # formatter.
    #
    source.formatter.excludes=\
        **/.git/**,\
        **/bin/**,\
        **/bundles/**,\
        **/classes/**,\
        **/test-classes/**,\
        **/test-coverage/**,\
        **/test-results/**,\
        **/tmp/**,\
        **/tools/sdk/**,\
        **/webapps/**,\
        portal-impl/src/portal-ext.properties

    #
    # Input a list of comma delimited file names that should be ignored when
    # checking for finalable, mutable, or staticable field types.
    #
    check.java.field.types.excludes.files=\
        modules/util/sync-engine/src/com/liferay/sync/engine/session/Session.java,\
        portal-impl/src/com/liferay/portal/tools/servicebuilder/ServiceBuilder.java,\
        portal-impl/test/unit/com/liferay/portal/json/One.java,\
        portal-impl/test/unit/com/liferay/portal/json/Two.java,\
        portal-service/src/com/liferay/portal/kernel/io/PathHolder.java

    #
    # Input a list of comma delimited file names that should be ignored when
    # applying diamond operators.
    #
    diamond.operator.excludes.files=\
        portal-impl/src/com/liferay/portlet/messageboards/util/MBMailMessage.java,\
        portal-service/src/com/liferay/portal/kernel/util/ListUtil.java,\
        portal-service/src/com/liferay/portal/kernel/util/ProxyUtil.java

    #
    # Input a list of comma delimited paths. Files that match any of these
    # paths, should be ignored when applying diamond operators.
    #
    diamond.operator.excludes.paths=\
        /ant-bnd/,\
        /io-delta/,\
        /markdown-converter/,\
        /osgi-util/

    #
    # Input a list of comma delimited file names that should be ignored when
    # trying to fit multiple lines on single line.
    #
    fit.on.single.line.excludes.files=\
        portal-impl/src/com/liferay/portal/backgroundtask/messaging/BackgroundTaskStatusMessageListener.java@32

    #
    # Input a list of comma delimited file names that are allowed to have
    # unalphabetized friendly URL routes.
    #
    friendly.url.routes.sort.excludes.files=\
        portal-impl/src/com/liferay/portlet/admin/admin-server-friendly-url-routes.xml,\
        portal-impl/src/com/liferay/portlet/assetpublisher/asset-publisher-friendly-url-routes.xml

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

    #
    # Input a list of comma delimited file names that are allowed to have Java
    # terms without an access level modifier specified.
    #
    javaterm.access.level.modifier.excludes.files=\
        portal-service/test/unit/com/liferay/portal/kernel/resiliency/spi/agent/annotation/DistributedRegistryTest.java@320

    #
    # Input a list of comma delimited file names that are allowed to have
    # unalphabetized Java terms. In addition these files are allowed to have
    # nonfinal variables that are capitalized.
    #
    javaterm.sort.excludes.files=\
        portal-impl/src/com/liferay/portal/util/PortalImpl.java@_logWebServerServlet,\
        portal-impl/src/com/liferay/portlet/journal/util/RegexTransformerUtil.java@_log,\
        portal-service/src/com/liferay/portal/kernel/log/LogFactoryUtil.java@_logFactory,\
        portal-service/src/com/liferay/portal/kernel/servlet/HttpHeaders.java,\
        portal-service/src/com/liferay/portal/kernel/util/JavaDetector.java@_log,\
        portal-service/src/com/liferay/portal/kernel/util/ReleaseInfo.java,\
        portal-service/src/com/liferay/portal/model/ListTypeConstants.java,\
        portal-service/src/com/liferay/portlet/UserAttributes.java

    #
    # Input a list of comma delimited JSP file names 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.files=\
        portal-web/docroot/html/taglib/ui/social_bookmark/init.jsp@20

    #
    # Input a list of comma delimited file names that are allowed to surpass the
    # 80 column limit.
    #
    line.length.excludes.files=\
        modules/apps/wiki/wiki-test/test/integration/com/liferay/wiki/subscription/WikiSubscriptionContainerModelTest.java,\
        modules/apps/wiki/wiki-test/test/integration/com/liferay/wiki/trash/WikiPageDependentsTrashHandlerTest.java,\
        modules/core/osgi-service-tracker-map/test/integration/com/liferay/osgi/service/tracker/map/test/ObjectServiceTrackerMapTest.java@431,\
        modules/portal/portal-template-freemarker/src/com/liferay/portal/template/freemarker/configuration/FreeMarkerEngineConfiguration.java@52,\
        modules/util/osgi-util/test/integration/com/liferay/osgi/util/test/ReflectionServiceTrackerTest.java@166,\
        modules/util/pmd/src/com/liferay/pmd/rules/java/OverrideBothEqualsAndHashcodeRule.java@28,\
        portal-impl/src/com/liferay/portal/fabric/netty/client/NettyFabricClientConfig.java@69,\
        portal-impl/src/com/liferay/portal/spring/hibernate/PortalHibernateConfiguration.java@287,\
        portal-impl/src/com/liferay/portal/tools/LangBuilder.java@462,\
        portal-impl/src/com/liferay/portal/tools/LangBuilder.java@469,\
        portal-impl/src/com/liferay/portal/tools/WebXML23Converter.java@81,\
        portal-impl/src/com/liferay/portal/tools/servicebuilder/ServiceBuilder.java,\
        portal-impl/src/com/liferay/portal/util/WebKeys.java,\
        portal-impl/test/integration/com/liferay/portal/lar/LayoutSetPrototypePropagationTest.java@256,\
        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/portal/service/PortletPreferencesLocalServiceTest.java,\
        portal-impl/test/integration/com/liferay/portlet/blogs/subscriptions/BlogsSubscriptionRootContainerModelTest.java,\
        portal-impl/test/integration/com/liferay/portlet/documentlibrary/service/persistence/DLFileEntryFinderTest.java,\
        portal-service/src/com/liferay/portal/kernel/search/QueryConfig.java@379,\
        portal-service/src/com/liferay/portal/kernel/util/PropsKeys.java,\
        portal-service/src/com/liferay/portal/kernel/util/WebKeys.java,\
        portal-test-internal/src/com/liferay/portlet/subscriptions/test/BaseSubscriptionContainerModelTestCase.java,\
        portal-test-internal/src/com/liferay/portlet/subscriptions/test/BaseSubscriptionRootContainerModelTestCase.java

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

    #
    # Input a list of comma delimited file names that are allowed to use
    # java.lang.reflect.Proxy.
    #
    proxy.excludes.files=\
        modules/portal/portal-servlet-jsp-compiler/src/com/liferay/portal/servlet/jsp/compiler/JspServlet.java,\
        modules/portal/portal-template-freemarker/src/com/liferay/portal/template/freemarker/FreeMarkerManager.java,\
        portal-impl/src/com/liferay/portal/server/DeepNamedValueScanner.java,\
        portal-service/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.paths=\
        /ant-bnd/,\
        /markdown-converter/,\
        /osgi-util/,\
        /portal-wab-extender/,\
        /registry-api/,\
        /sync-engine/

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

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

    #
    # Input a list of comma delimited file names that are exluded when checking
    # for correct use of test annotations.
    #
    test.annotations.excludes.files=

    #
    # Input a list of comma delimited upgrade file names that are allowed to
    # call ServiceUtil methods. See LPS-34911.
    #
    upgrade.service.util.excludes.files=\
        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 XML file names that are allowed to have
    # lines that start with spaces.
    #
    xml.excludes.files=\
        definitions/web-facesconfig_1_2.xml,\
        portal-web/docroot/dtd/web-facesconfig_1_2.xml,\
        util-taglib/src/com/liferay/taglib/aui.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 excpected 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=