Package net.octyl.levelheadered.internal

Interface HeaderWorkParameters

All Superinterfaces:
org.gradle.workers.WorkParameters
public interface HeaderWorkParameters extends org.gradle.workers.WorkParameters
Parameters for header work actions.

Not to be implemented by users.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.gradle.workers.WorkParameters

    org.gradle.workers.WorkParameters.None

  • Method Summary

    Modifier and Type
    Method
    Description
    org.gradle.api.provider.Property<String>
    getHeaderText()
    Returns the header text to apply to the source file.
    org.gradle.api.provider.Property<FileHeaderRewriter>
    getRewriter()
    Returns the rewriter to use to apply the header text to the source file.
    org.gradle.api.file.RegularFileProperty
    getSourceFile()
    Returns the source file to apply the header to.

  • Method Details

    • getHeaderText

      org.gradle.api.provider.Property<String> getHeaderText()
      Returns the header text to apply to the source file. It is not yet in the comment format.
      Returns:
      the header text to apply to the source file

    • getRewriter

      org.gradle.api.provider.Property<FileHeaderRewriter> getRewriter()
      Returns the rewriter to use to apply the header text to the source file.
      Returns:
      the rewriter to use to apply the header text to the source file

    • getSourceFile

      org.gradle.api.file.RegularFileProperty getSourceFile()
      Returns the source file to apply the header to.
      Returns:
      the source file to apply the header to