org.springframework.boot.gradle

Class SpringBootPluginExtension

java.lang.Object

org.springframework.boot.gradle.SpringBootPluginExtension

public class SpringBootPluginExtension
extends Object

Gradle DSL Extension for 'Spring Boot'. Most of the time Spring Boot can guess the settings in this extension, but occasionally you might need to explicitly set one or two of them. E.g.

     apply plugin: 'org.springframework.boot'
     springBoot {
         mainClass = 'org.demo.Application'
         layout = 'ZIP'
     }
 

Author:

Phillip Webb, Dave Syer, Stephane Nicoll, Andy Wilkinson

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SpringBootPluginExtension.LayoutType Layout Types.

Constructor Summary

Constructors

Constructor and Description
SpringBootPluginExtension(org.gradle.api.Project project)

Method Summary

Modifier and Type	Method and Description
void	buildInfo()
void	buildInfo(groovy.lang.Closure<?> taskConfigurer)
Layout	convertLayout() Convenience method for use in a custom task.
File	getAgent()
String	getClassifier()
String	getCustomConfiguration()
File	getEmbeddedLaunchScript()
Map<String,String>	getEmbeddedLaunchScriptProperties()
SpringBootPluginExtension.LayoutType	getLayout()
LayoutFactory	getLayoutFactory()
String	getMainClass()
Boolean	getNoverify()
String	getProvidedConfiguration()
Set<String>	getRequiresUnpack()
boolean	isApplyExcludeRules()
boolean	isBackupSource()
boolean	isExcludeDevtools()
boolean	isExecutable()
void	setAgent(File agent)
void	setApplyExcludeRules(boolean applyExcludeRules)
void	setBackupSource(boolean backupSource)
void	setClassifier(String classifier)
void	setCustomConfiguration(String customConfiguration)
void	setEmbeddedLaunchScript(File embeddedLaunchScript)
void	setEmbeddedLaunchScriptProperties(Map<String,String> embeddedLaunchScriptProperties)
void	setExcludeDevtools(boolean excludeDevtools)
void	setExecutable(boolean executable)
void	setLayout(SpringBootPluginExtension.LayoutType layout)
void	setLayoutFactory(LayoutFactory layoutFactory)
void	setMainClass(String mainClass)
void	setNoverify(Boolean noverify)
void	setProvidedConfiguration(String providedConfiguration)
void	setRequiresUnpack(Set<String> requiresUnpack)

Methods inherited from class java.lang.Object

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

Constructor Detail

SpringBootPluginExtension

public SpringBootPluginExtension(org.gradle.api.Project project)

Method Detail

convertLayout

public Layout convertLayout()

Convenience method for use in a custom task.

Returns:

the Layout to use or null if not explicitly set

getMainClass

public String getMainClass()

setMainClass

public void setMainClass(String mainClass)

getClassifier

public String getClassifier()

setClassifier

public void setClassifier(String classifier)

getProvidedConfiguration

public String getProvidedConfiguration()

setProvidedConfiguration

public void setProvidedConfiguration(String providedConfiguration)

getCustomConfiguration

public String getCustomConfiguration()

setCustomConfiguration

public void setCustomConfiguration(String customConfiguration)

isBackupSource

public boolean isBackupSource()

setBackupSource

public void setBackupSource(boolean backupSource)

getLayout

public SpringBootPluginExtension.LayoutType getLayout()

setLayout

public void setLayout(SpringBootPluginExtension.LayoutType layout)

getLayoutFactory

public LayoutFactory getLayoutFactory()

setLayoutFactory

public void setLayoutFactory(LayoutFactory layoutFactory)

getRequiresUnpack

public Set<String> getRequiresUnpack()

setRequiresUnpack

public void setRequiresUnpack(Set<String> requiresUnpack)

isExcludeDevtools

public boolean isExcludeDevtools()

setExcludeDevtools

public void setExcludeDevtools(boolean excludeDevtools)

getAgent

public File getAgent()

setAgent

public void setAgent(File agent)

getNoverify

public Boolean getNoverify()

setNoverify

public void setNoverify(Boolean noverify)

isApplyExcludeRules

public boolean isApplyExcludeRules()

setApplyExcludeRules

public void setApplyExcludeRules(boolean applyExcludeRules)

isExecutable

public boolean isExecutable()

setExecutable

public void setExecutable(boolean executable)

getEmbeddedLaunchScript

public File getEmbeddedLaunchScript()

setEmbeddedLaunchScript

public void setEmbeddedLaunchScript(File embeddedLaunchScript)

getEmbeddedLaunchScriptProperties

public Map<String,String> getEmbeddedLaunchScriptProperties()

setEmbeddedLaunchScriptProperties

public void setEmbeddedLaunchScriptProperties(Map<String,String> embeddedLaunchScriptProperties)

buildInfo

public void buildInfo()

buildInfo

public void buildInfo(groovy.lang.Closure<?> taskConfigurer)