Class IndraSpotlessLicenserExtensionImpl
java.lang.Object
net.kyori.indra.licenser.spotless.internal.IndraSpotlessLicenserExtensionImpl
- All Implemented Interfaces:
IndraSpotlessLicenserExtension
public class IndraSpotlessLicenserExtensionImpl
extends Object
implements IndraSpotlessLicenserExtension
-
Constructor Summary
ConstructorsConstructorDescriptionIndraSpotlessLicenserExtensionImpl(org.gradle.api.model.ObjectFactory objects, org.gradle.api.resources.TextResourceFactory textResources) -
Method Summary
Modifier and TypeMethodDescriptioncom.diffplug.spotless.ThrowingEx.Supplier<String>createHeaderSupplier(String name) voidextraConfig(@NotNull org.gradle.api.Action<com.diffplug.gradle.spotless.FormatExtension.LicenseHeaderConfig> configureStep) Add an extra configure step to modify applied license header configurations.List<org.gradle.api.Action<com.diffplug.gradle.spotless.FormatExtension.LicenseHeaderConfig>>@NotNull org.gradle.api.provider.Property<HeaderFormat>A property containing the header format to use.voidlanguageFormatOverride(@NotNull String language, @NotNull HeaderFormat headerFormat) Set a language format override for a specific formatter task.voidlanguageFormatOverride(@NotNull String language, @NotNull org.gradle.api.Action<HeaderFormatApplier> configurer) Set a language format override for a specific formatter task.@NotNull org.gradle.api.provider.MapProperty<String,HeaderFormat> A property providing language-specific header format overrides.@NotNull org.gradle.api.provider.Property<org.gradle.api.resources.TextResource>A property holding the file to use for a license header.voidlicenseHeaderFile(@NotNull Object file) Set the license header file to use.@NotNull org.gradle.api.provider.Property<Boolean>newLine()Get whether to append an additional newline at the end of files.Properties to replace within license header contents.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface net.kyori.indra.licenser.spotless.IndraSpotlessLicenserExtension
headerFormat, headerFormat, newLine, property, property
-
Constructor Details
-
IndraSpotlessLicenserExtensionImpl
@Inject public IndraSpotlessLicenserExtensionImpl(org.gradle.api.model.ObjectFactory objects, org.gradle.api.resources.TextResourceFactory textResources)
-
-
Method Details
-
licenseHeaderFile
@NotNull public @NotNull org.gradle.api.provider.Property<org.gradle.api.resources.TextResource> licenseHeaderFile()Description copied from interface:IndraSpotlessLicenserExtensionA property holding the file to use for a license header.- Specified by:
licenseHeaderFilein interfaceIndraSpotlessLicenserExtension- Returns:
- the license header file property
-
licenseHeaderFile
Description copied from interface:IndraSpotlessLicenserExtensionSet the license header file to use.The contents of this file will be processed to apply a comment style and expand template parameters.
- Specified by:
licenseHeaderFilein interfaceIndraSpotlessLicenserExtension- Parameters:
file- the file to read, viaProject.file()
-
headerFormat
Description copied from interface:IndraSpotlessLicenserExtensionA property containing the header format to use.Language-specific overrides can be set using
IndraSpotlessLicenserExtension.languageFormatOverride(String, HeaderFormat).- Specified by:
headerFormatin interfaceIndraSpotlessLicenserExtension- Returns:
- the header format property
-
languageFormatOverrides
@NotNull public @NotNull org.gradle.api.provider.MapProperty<String,HeaderFormat> languageFormatOverrides()Description copied from interface:IndraSpotlessLicenserExtensionA property providing language-specific header format overrides.- Specified by:
languageFormatOverridesin interfaceIndraSpotlessLicenserExtension- Returns:
- the map property containing overrides
-
languageFormatOverride
public void languageFormatOverride(@NotNull @NotNull String language, @NotNull @NotNull HeaderFormat headerFormat) Description copied from interface:IndraSpotlessLicenserExtensionSet a language format override for a specific formatter task.- Specified by:
languageFormatOverridein interfaceIndraSpotlessLicenserExtension- Parameters:
language- the formatter task to configureheaderFormat- the header format to apply
-
languageFormatOverride
public void languageFormatOverride(@NotNull @NotNull String language, @NotNull @NotNull org.gradle.api.Action<HeaderFormatApplier> configurer) Description copied from interface:IndraSpotlessLicenserExtensionSet a language format override for a specific formatter task.- Specified by:
languageFormatOverridein interfaceIndraSpotlessLicenserExtension- Parameters:
language- the formatter task to configureconfigurer- an action that will be passed callbacks for common header format presets
-
properties
Description copied from interface:IndraSpotlessLicenserExtensionProperties to replace within license header contents.The Groovy
SimpleTemplateEngineis used to pre-process license headers.- Specified by:
propertiesin interfaceIndraSpotlessLicenserExtension- Returns:
- the properties map
-
newLine
Description copied from interface:IndraSpotlessLicenserExtensionGet whether to append an additional newline at the end of files.- Specified by:
newLinein interfaceIndraSpotlessLicenserExtension- Returns:
- the newline property
-
extraConfig
public void extraConfig(@NotNull @NotNull org.gradle.api.Action<com.diffplug.gradle.spotless.FormatExtension.LicenseHeaderConfig> configureStep) Description copied from interface:IndraSpotlessLicenserExtensionAdd an extra configure step to modify applied license header configurations.- Specified by:
extraConfigin interfaceIndraSpotlessLicenserExtension- Parameters:
configureStep- the extra configuration step
-
extraConfigSteps
public List<org.gradle.api.Action<com.diffplug.gradle.spotless.FormatExtension.LicenseHeaderConfig>> extraConfigSteps() -
createHeaderSupplier
-