Package net.octyl.levelheadered

Interface LevelHeaderedConfig

All Known Implementing Classes:
HeaderApplyTask, HeaderVerifyTask, HeaderWorkerSourceTask, LevelHeaderedExtension
public interface LevelHeaderedConfig
Shared configuration interface between the extension and tasks.

Not to be implemented by users.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.gradle.api.provider.Property<org.gradle.api.resources.TextResource>
    getHeaderTemplate()
    Returns the header template to apply to source files.
    org.gradle.api.provider.MapProperty<String,FileHeaderRewriter>
    getRewriters()
    Returns the rewriters to use for different file types.
    org.gradle.api.provider.Property<org.gradle.api.tasks.util.PatternSet>
    getSourceMatchPatterns()
    Returns the patterns to match source files to apply headers to.
    org.gradle.api.provider.MapProperty<String,String>
    getTemplateVariables()
    Returns the template variables to use when expanding the header template.

  • Method Details

    • getRewriters

      org.gradle.api.provider.MapProperty<String,FileHeaderRewriter> getRewriters()
      Returns the rewriters to use for different file types. This map is keyed primarily by file extensions with the leading dot (e.g. .java, .xml), but may also be keyed by full file names for those that do not have extensions (e.g. Makefile).
      Returns:
      the rewriters to use for different file types

    • getHeaderTemplate

      org.gradle.api.provider.Property<org.gradle.api.resources.TextResource> getHeaderTemplate()
      Returns the header template to apply to source files. This is expanded using SimpleTemplateEngine.
      Returns:
      the header template to apply to source files

    • getTemplateVariables

      @Input org.gradle.api.provider.MapProperty<String,String> getTemplateVariables()
      Returns the template variables to use when expanding the header template.
      Returns:
      the template variables to use when expanding the header template

    • getSourceMatchPatterns

      @Internal org.gradle.api.provider.Property<org.gradle.api.tasks.util.PatternSet> getSourceMatchPatterns()
      Returns the patterns to match source files to apply headers to.

      These are used in combination with the filters on the source files of the task. By default, this is an empty pattern set, meaning all source files are considered.

      Returns:
      the patterns to match source files to apply headers to