com.linkedin.pegasus.gradle.tasks

Class GenerateRestModelTask

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

com.linkedin.pegasus.gradle.tasks.GenerateRestModelTask

All Implemented Interfaces:

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

@CacheableTask
public class GenerateRestModelTask
extends org.gradle.api.DefaultTask

Generate the idl file from the annotated java classes. This also requires access to the classes that were used to compile these java classes. Projects with no IdlItem will be excluded from this task As prerequisite of this task, add these lines to your build.gradle:

 apply plugin: 'li-pegasus2'
 

Optionally, to generate idl for specific packages, add

 pegasus.<sourceSet>.idlOptions.addIdlItem(['<packageName>'])
 

Nested Class Summary

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

org.gradle.api.Task.Namer

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	INCLUDED_SOURCE_TYPES_PROPERTY

Fields inherited from interface org.gradle.api.Task

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

Constructor Summary

Constructors

Constructor and Description
GenerateRestModelTask()

Method Summary

Modifier and Type	Method and Description
void	generate()
org.gradle.api.file.FileCollection	getCodegenClasspath()
java.io.File	getIdlDestinationDir()
PegasusOptions.IdlOptions	getIdlOptions()
java.util.Set<java.io.File>	getInputDirs()
org.gradle.api.file.FileCollection	getResolverPath()
java.io.File	getSnapshotDestinationDir()
org.gradle.api.file.FileCollection	getWatchedCodegenClasspath()
java.util.Set<java.io.File>	getWatchedInputDirs()
void	setCodegenClasspath(org.gradle.api.file.FileCollection codegenClasspath)
void	setIdlDestinationDir(java.io.File idlDestinationDir)
void	setIdlOptions(PegasusOptions.IdlOptions idlOptions)
void	setInputDirs(java.util.Set<java.io.File> inputDirs)
void	setResolverPath(org.gradle.api.file.FileCollection resolverPath)
void	setSnapshotDestinationDir(java.io.File snapshotDestinationDir)
void	setWatchedCodegenClasspath(org.gradle.api.file.FileCollection watchedCodegenClasspath)
void	setWatchedInputDirs(java.util.Set<java.io.File> watchedInputDirs)

Methods inherited from class org.gradle.api.DefaultTask

newInputDirectory, newInputFile, newOutputDirectory, newOutputFile

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

addValidator, appendParallelSafeAction, compareTo, configure, deleteAllActions, dependsOn, dependsOnTaskDidWork, doFirst, doFirst, doFirst, doLast, doLast, doLast, execute, finalizedBy, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExecuter, getExtensions, getFinalizedBy, getGroup, getIdentityPath, getImpliesSubProjects, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getShouldRunAfter, getStandardOutputCapture, getState, getTaskActions, getTaskDependencies, getTemporaryDir, getTemporaryDirFactory, getValidators, hasProperty, injectIntoNewInstance, isEnabled, isHasCustomActions, leftShift, mustRunAfter, onlyIf, onlyIf, prependParallelSafeAction, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setExecuter, setFinalizedBy, setGroup, setImpliesSubProjects, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, toString

Methods inherited from class java.lang.Object

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

Field Detail

INCLUDED_SOURCE_TYPES_PROPERTY

public static final java.lang.String INCLUDED_SOURCE_TYPES_PROPERTY

See Also:

Constant Field Values

Constructor Detail

GenerateRestModelTask

public GenerateRestModelTask()

Method Detail

generate

public void generate()

getWatchedCodegenClasspath

@Classpath
public org.gradle.api.file.FileCollection getWatchedCodegenClasspath()

setWatchedCodegenClasspath

public void setWatchedCodegenClasspath(org.gradle.api.file.FileCollection watchedCodegenClasspath)

getWatchedInputDirs

@InputFiles
 @SkipWhenEmpty
 @PathSensitive(value=RELATIVE)
public java.util.Set<java.io.File> getWatchedInputDirs()

setWatchedInputDirs

public void setWatchedInputDirs(java.util.Set<java.io.File> watchedInputDirs)

getResolverPath

@Classpath
public org.gradle.api.file.FileCollection getResolverPath()

setResolverPath

public void setResolverPath(org.gradle.api.file.FileCollection resolverPath)

getIdlDestinationDir

@OutputDirectory
 @PathSensitive(value=NAME_ONLY)
public java.io.File getIdlDestinationDir()

setIdlDestinationDir

public void setIdlDestinationDir(java.io.File idlDestinationDir)

getSnapshotDestinationDir

@OutputDirectory
public java.io.File getSnapshotDestinationDir()

setSnapshotDestinationDir

public void setSnapshotDestinationDir(java.io.File snapshotDestinationDir)

getIdlOptions

@Internal
public PegasusOptions.IdlOptions getIdlOptions()

setIdlOptions

public void setIdlOptions(PegasusOptions.IdlOptions idlOptions)

getCodegenClasspath

@Internal
public org.gradle.api.file.FileCollection getCodegenClasspath()

setCodegenClasspath

public void setCodegenClasspath(org.gradle.api.file.FileCollection codegenClasspath)

getInputDirs

@Internal
public java.util.Set<java.io.File> getInputDirs()

setInputDirs

public void setInputDirs(java.util.Set<java.io.File> inputDirs)