Package com.getkeepsafe.dexcount

Class DexCountExtension

    • Constructor Summary

      Constructors 
      Constructor Description
      DexCountExtension​(org.gradle.api.model.ObjectFactory objects, org.gradle.api.provider.ProviderFactory providers)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.gradle.api.provider.Property<Boolean> getEnabled()
      When true, the plugin is enabled and will be run as normal.
      org.gradle.api.provider.Property<OutputFormat> getFormat()
      The format of the method count output, either "list", "tree", "json", or "yaml".
      org.gradle.api.provider.Property<Boolean> getIncludeClassCount()
      When true, the number of classes in a package or class will be included in the printed output.
      org.gradle.api.provider.Property<Boolean> getIncludeClasses()
      When true, individual classes will be include in the package list - otherwise, only packages are included.
      org.gradle.api.provider.Property<Boolean> getIncludeFieldCount()
      When true, the number of fields in a package or class will be included in the printed output.
      org.gradle.api.provider.Property<Boolean> getIncludeTotalMethodCount()
      When true, the total number of methods in the application will be included in the printed output.
      org.gradle.api.provider.Property<Integer> getMaxMethodCount()
      When set, the build will fail when the APK/AAR has more methods than the max.
      org.gradle.api.provider.Property<Integer> getMaxTreeDepth()
      Sets the max number of package segments in the output - i.e.
      org.gradle.api.provider.Property<Boolean> getOrderByMethodCount()
      When true, packages will be sorted in descending order by the number of methods they contain.
      org.gradle.api.provider.Property<Boolean> getPrintDeclarations()
      When true, then the plugin only counts the declared methods and fields inside this module.
      org.gradle.api.provider.Property<Boolean> getPrintVersion()
      If the user has passed '--stacktrace' or '--full-stacktrace', assume that they are trying to report a dexcount bug.
      org.gradle.api.provider.Property<Boolean> getRunOnEachPackage()
      When false, does not automatically count methods following the `package` task.
      org.gradle.api.provider.Property<Boolean> getTeamCityIntegration()
      When true, Team City integration strings will be printed.
      org.gradle.api.provider.Property<String> getTeamCitySlug()
      A string which, if specified, will be added to TeamCity stat names.
      org.gradle.api.provider.Property<Boolean> getVerbose()
      When true, the output file will also be printed to the build's standard output.

    • Constructor Detail

      • DexCountExtension

        @Inject
public DexCountExtension​(org.gradle.api.model.ObjectFactory objects,
                         org.gradle.api.provider.ProviderFactory providers)

    • Method Detail

      • getRunOnEachPackage

        @Internal("plugin input, not task input")
public org.gradle.api.provider.Property<Boolean> getRunOnEachPackage()
        When false, does not automatically count methods following the `package` task.

      • getFormat

        @Input
public org.gradle.api.provider.Property<OutputFormat> getFormat()
        The format of the method count output, either "list", "tree", "json", or "yaml".

      • getIncludeClasses

        @Input
public org.gradle.api.provider.Property<Boolean> getIncludeClasses()
        When true, individual classes will be include in the package list - otherwise, only packages are included.

      • getIncludeClassCount

        @Input
public org.gradle.api.provider.Property<Boolean> getIncludeClassCount()
        When true, the number of classes in a package or class will be included in the printed output.

      • getIncludeFieldCount

        @Input
public org.gradle.api.provider.Property<Boolean> getIncludeFieldCount()
        When true, the number of fields in a package or class will be included in the printed output.

      • getIncludeTotalMethodCount

        @Input
public org.gradle.api.provider.Property<Boolean> getIncludeTotalMethodCount()
        When true, the total number of methods in the application will be included in the printed output.

      • getOrderByMethodCount

        @Input
public org.gradle.api.provider.Property<Boolean> getOrderByMethodCount()
        When true, packages will be sorted in descending order by the number of methods they contain.

      • getVerbose

        @Internal
public org.gradle.api.provider.Property<Boolean> getVerbose()
        When true, the output file will also be printed to the build's standard output.

      • getMaxTreeDepth

        @Input
public org.gradle.api.provider.Property<Integer> getMaxTreeDepth()
        Sets the max number of package segments in the output - i.e. when set to 2, counts stop at com.google, when set to 3 you get com.google.android, etc. "Unlimited" by default.

      • getTeamCityIntegration

        @Internal("TeamCity stats are stdout-only")
public org.gradle.api.provider.Property<Boolean> getTeamCityIntegration()
        When true, Team City integration strings will be printed. If the TEAMCITY_VERSION System environment variable is defined this will become true by default.

      • getTeamCitySlug

        @Internal("TeamCity stats are stdout-only")
public org.gradle.api.provider.Property<String> getTeamCitySlug()
        A string which, if specified, will be added to TeamCity stat names. Null by default.

      • getMaxMethodCount

        @Input
public org.gradle.api.provider.Property<Integer> getMaxMethodCount()
        When set, the build will fail when the APK/AAR has more methods than the max. 0 by default.

      • getPrintVersion

        @Internal("stdout-only")
public org.gradle.api.provider.Property<Boolean> getPrintVersion()
        If the user has passed '--stacktrace' or '--full-stacktrace', assume that they are trying to report a dexcount bug. Help us help them out by printing the current plugin title and version.

      • getPrintDeclarations

        @Input
public org.gradle.api.provider.Property<Boolean> getPrintDeclarations()
        When true, then the plugin only counts the declared methods and fields inside this module. This does NOT represent the actual reference method count, because method references are ignored. This flag is false by default and can only be turned on for library modules.

      • getEnabled

        @Internal("this is plugin input, not task input")
public org.gradle.api.provider.Property<Boolean> getEnabled()
        When true, the plugin is enabled and will be run as normal. When false, the plugin is disabled and will not be run.