Package run.halo.gradle.openapi

Class AbstractOpenApiDocsTask

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

run.halo.gradle.docker.AbstractDockerRemoteApiTask

run.halo.gradle.docker.DockerExistingImage

run.halo.gradle.openapi.AbstractOpenApiDocsTask

All Implemented Interfaces:

Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, org.gradle.api.Named, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>

Direct Known Subclasses:

DockerCreateContainer, OpenApiDocsGeneratorTask

public abstract class AbstractOpenApiDocsTask
extends DockerExistingImage

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static final record	AbstractOpenApiDocsTask.SpringDocGroupConfig

Nested classes/interfaces inherited from interface org.gradle.api.Task

org.gradle.api.Task.Namer

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.gradle.api.provider.MapProperty<String,String>	groupedApiMappings
protected final org.gradle.api.file.DirectoryProperty	outputDir

Fields inherited from interface org.gradle.api.Task

TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

Constructor Summary

Constructors

Constructor	Description
AbstractOpenApiDocsTask()

Method Summary

Modifier and Type	Method	Description
protected com.fasterxml.jackson.databind.JsonNode	generateSpringDocApplicationConfig()
protected static String	generateSpringDocConfigString(List<AbstractOpenApiDocsTask.SpringDocGroupConfig> configs)
org.gradle.api.provider.Property<String>	getApiDocsUrl()
org.gradle.api.provider.Property<String>	getApiDocsVersion()
org.gradle.api.provider.MapProperty<String,String>	getGroupedApiMappings()
org.gradle.api.file.DirectoryProperty	getOutputDir()
HaloPluginExtension	getPluginExtension()
List<AbstractOpenApiDocsTask.SpringDocGroupConfig>	getSpringDocGroupConfigs()

Methods inherited from class run.halo.gradle.docker.DockerExistingImage

getImageId, targetImageId, targetImageId, targetImageId

Methods inherited from class run.halo.gradle.docker.AbstractDockerRemoteApiTask

getApiVersion, getCertPath, getDockerClient, getDockerClientService, getNextHandler, getUrl, onComplete, onError, onNext, runRemoteCommand, start

Methods inherited from class org.gradle.api.DefaultTask

compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

Methods inherited from class org.gradle.api.internal.AbstractTask

acceptServiceReferences, appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjects

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.gradle.api.Task

doNotTrackState, getConvention, notCompatibleWithConfigurationCache

Field Details

groupedApiMappings

@Input
protected final org.gradle.api.provider.MapProperty<String,String> groupedApiMappings

outputDir

@Internal
protected final org.gradle.api.file.DirectoryProperty outputDir

Constructor Details

AbstractOpenApiDocsTask

public AbstractOpenApiDocsTask()

Method Details

generateSpringDocApplicationConfig

protected com.fasterxml.jackson.databind.JsonNode generateSpringDocApplicationConfig()

generateSpringDocConfigString

protected static String generateSpringDocConfigString(@Nonnull
 List<AbstractOpenApiDocsTask.SpringDocGroupConfig> configs)

getPluginExtension

public HaloPluginExtension getPluginExtension()

getGroupedApiMappings

public org.gradle.api.provider.MapProperty<String,String> getGroupedApiMappings()

getApiDocsVersion

public org.gradle.api.provider.Property<String> getApiDocsVersion()

getApiDocsUrl

public org.gradle.api.provider.Property<String> getApiDocsUrl()

getOutputDir

public org.gradle.api.file.DirectoryProperty getOutputDir()

getSpringDocGroupConfigs

public List<AbstractOpenApiDocsTask.SpringDocGroupConfig> getSpringDocGroupConfigs()