Antlr4Extension (plugin-gradle 6.9.1 API)

java.lang.Object
- com.diffplug.gradle.spotless.FormatExtension
- - com.diffplug.gradle.spotless.Antlr4Extension

All Implemented Interfaces:: HasBuiltinDelimiterForLicense

public class Antlr4Extension
extends FormatExtension
implements HasBuiltinDelimiterForLicense

Nested Class Summary

Nested Classes
Modifier and Type Class Description

class Antlr4Extension.Antlr4FormatterConfig
- Nested classes/interfaces inherited from class com.diffplug.gradle.spotless.FormatExtension
  FormatExtension.ClangFormatConfig, FormatExtension.EclipseWtpConfig, FormatExtension.LicenseHeaderConfig, FormatExtension.NpmStepConfig<T extends FormatExtension.NpmStepConfig<?>>, FormatExtension.PrettierConfig

Field Summary
- Fields inherited from class com.diffplug.gradle.spotless.FormatExtension
  steps, target, targetExclude

Constructor Summary

Constructors
Constructor Description

Antlr4Extension(SpotlessExtension rootExtension)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Antlr4Extension.Antlr4FormatterConfig`	`antlr4Formatter()`
`Antlr4Extension.Antlr4FormatterConfig`	`antlr4Formatter(String version)`
`FormatExtension.LicenseHeaderConfig`	`licenseHeader(String licenseHeader)`
`FormatExtension.LicenseHeaderConfig`	`licenseHeaderFile(Object licenseHeaderFile)`
`protected void`	`setupTask(SpotlessTask task)`	Sets up a format task according to the values in this extension.

Methods inherited from class com.diffplug.gradle.spotless.FormatExtension
addStep, bumpThisNumberIfACustomStepChanges, clangFormat, clangFormat, clearSteps, createIndependentApplyTask, createIndependentApplyTaskLazy, custom, custom, eclipseWtp, eclipseWtp, encoding, endWithNewline, getEncoding, getExistingStepIdx, getLineEndings, getProject, getRatchetFrom, ignoreErrorForPath, ignoreErrorForStep, indentWithSpaces, indentWithSpaces, indentWithTabs, indentWithTabs, isLicenseHeaderStep, licenseHeader, licenseHeaderFile, nativeCmd, noDefaultTargetException, parseTarget, prettier, prettier, prettier, provisioner, ratchetFrom, replace, replaceRegex, replaceStep, setEncoding, setEncoding, setLineEndings, setRatchetFrom, target, targetExclude, toggleOffOn, toggleOffOn, toggleOffOnDisable, toggleOffOnRegex, trimTrailingWhitespace, withinBlocks, withinBlocks, withinBlocksRegex, withinBlocksRegex

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Antlr4Extension
```
@Inject
public Antlr4Extension(SpotlessExtension rootExtension)
```
- Method Detail
  - antlr4Formatter
```
public Antlr4Extension.Antlr4FormatterConfig antlr4Formatter()
```
  - antlr4Formatter
```
public Antlr4Extension.Antlr4FormatterConfig antlr4Formatter(String version)
```
  - setupTask
```
protected void setupTask(SpotlessTask task)
```
    Description copied from class: FormatExtension
    
    Sets up a format task according to the values in this extension.
    
    Overrides:
    
    setupTask in class FormatExtension
  - licenseHeader
```
public FormatExtension.LicenseHeaderConfig licenseHeader(String licenseHeader)
```
    Specified by:
    
    licenseHeader in interface HasBuiltinDelimiterForLicense
    
    Parameters:
    
    licenseHeader - Content that should be at the top of every file.
  - licenseHeaderFile
```
public FormatExtension.LicenseHeaderConfig licenseHeaderFile(Object licenseHeaderFile)
```
    Specified by:
    
    licenseHeaderFile in interface HasBuiltinDelimiterForLicense
    
    Parameters:
    
    licenseHeaderFile - Content that should be at the top of every file.