Package com.atlassian.bamboo.configuration.external.exporters

Interface SpecsExporter

All Known Implementing Classes:

SpecsExporterImpl

@ExperimentalApi
public interface SpecsExporter

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	SpecsExporter.ExportFormat

Method Summary

Modifier and Type	Method	Description
String	getCodeFromDeploymentProject(DeploymentProject deploymentProject, SpecsExporter.ExportFormat format, String packageName, String className)	Convert a deployment plan to a Java Bamboo Spec
String	getCodeFromPlan(ImmutableTopLevelPlan immutableTopLevelPlan)	Delegates to getCodeFromPlan(ImmutableTopLevelPlan, ExportFormat, String, String) with a default packageName and className
String	getCodeFromPlan(ImmutableTopLevelPlan immutableTopLevelPlan, SpecsExporter.ExportFormat format, @Nullable String packageName, @Nullable String className)	Convert a plan to a Java Bamboo Spec

Method Details

getCodeFromPlan

String getCodeFromPlan(ImmutableTopLevelPlan immutableTopLevelPlan)
                throws com.atlassian.bamboo.specs.api.codegen.CodeGenerationException

Delegates to getCodeFromPlan(ImmutableTopLevelPlan, ExportFormat, String, String) with a default packageName and className

Parameters:

immutableTopLevelPlan -

Throws:

com.atlassian.bamboo.specs.api.codegen.CodeGenerationException

getCodeFromPlan

String getCodeFromPlan(ImmutableTopLevelPlan immutableTopLevelPlan,
 SpecsExporter.ExportFormat format,
 @Nullable
 @Nullable String packageName,
 @Nullable
 @Nullable String className)
                throws com.atlassian.bamboo.specs.api.codegen.CodeGenerationException

Convert a plan to a Java Bamboo Spec

Parameters:

immutableTopLevelPlan - The top level plan to extract

format - specs format (Java or YAML)

packageName - The package to put the spec in

className - The class name for the spec

Throws:

com.atlassian.bamboo.specs.api.codegen.CodeGenerationException - if generating the file fails

getCodeFromDeploymentProject

String getCodeFromDeploymentProject(DeploymentProject deploymentProject,
 SpecsExporter.ExportFormat format,
 String packageName,
 String className)
                             throws com.atlassian.bamboo.specs.api.codegen.CodeGenerationException

Convert a deployment plan to a Java Bamboo Spec

Parameters:

deploymentProject - The top level plan to extract

format - specs format (Java or YAML)

packageName - The package to put the spec in

className - The class name for the spec

Throws:

com.atlassian.bamboo.specs.api.codegen.CodeGenerationException - if generating the file fails