Package step.plans.parser.yaml

Class YamlPlanReader

java.lang.Object

step.plans.parser.yaml.YamlPlanReader

public class YamlPlanReader
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	YAML_PLANS_COLLECTION_NAME

Constructor Summary

Constructors

Constructor	Description
YamlPlanReader()	Creates the new Yaml plan reader with actual version and json schema
YamlPlanReader(step.core.Version currentVersion, String jsonSchemaPath)	Creates the new Yaml plan serializer for the specified current version and json schema

Method Summary

Modifier and Type	Method	Description
void	convertFromPlainTextToYaml(String planName, InputStream planTextInputStream, OutputStream yamlOutputStream)
protected YamlRootArtefactDeserializer	createRootArtefactDeserializer()
protected YamlRootArtefactSerializer	createRootArtefactSerializer()
protected com.fasterxml.jackson.databind.ObjectMapper	createYamlPlanObjectMapper()
protected com.fasterxml.jackson.databind.ObjectMapper	getYamlMapper()
protected step.migration.MigrationManager	initMigrationManager()	Initializes the migration manager with specific migrations used for yaml plan format
protected YamlPlan	planToYamlPlan(Plan plan)
protected String	readJsonSchema(String jsonSchemaPath)
Plan	readYamlPlan(InputStream yamlPlanStream)	Read the plan from Yaml
void	writeYamlPlan(OutputStream os, Plan plan)	Writes the plan as YAML
protected Plan	yamlPlanToPlan(YamlPlan yamlPlan)

Methods inherited from class java.lang.Object

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

Field Details

YAML_PLANS_COLLECTION_NAME

public static final String YAML_PLANS_COLLECTION_NAME

See Also:

• Constant Field Values

Constructor Details

YamlPlanReader

public YamlPlanReader(step.core.Version currentVersion,
 String jsonSchemaPath)

Creates the new Yaml plan serializer for the specified current version and json schema

YamlPlanReader

public YamlPlanReader()

Creates the new Yaml plan reader with actual version and json schema

Method Details

readYamlPlan

public Plan readYamlPlan(InputStream yamlPlanStream)
                  throws IOException,
YamlPlanValidationException

Read the plan from Yaml

Parameters:

yamlPlanStream - yaml data

Throws:

IOException

YamlPlanValidationException

writeYamlPlan

public void writeYamlPlan(OutputStream os,
 Plan plan)
                   throws IOException

Writes the plan as YAML

Throws:

IOException

convertFromPlainTextToYaml

public void convertFromPlainTextToYaml(String planName,
 InputStream planTextInputStream,
 OutputStream yamlOutputStream)
                                throws IOException,
StepsParser.ParsingException

Throws:

IOException

StepsParser.ParsingException

createYamlPlanObjectMapper

protected com.fasterxml.jackson.databind.ObjectMapper createYamlPlanObjectMapper()

createRootArtefactSerializer

protected YamlRootArtefactSerializer createRootArtefactSerializer()

createRootArtefactDeserializer

protected YamlRootArtefactDeserializer createRootArtefactDeserializer()

getYamlMapper

protected com.fasterxml.jackson.databind.ObjectMapper getYamlMapper()

readJsonSchema

protected String readJsonSchema(String jsonSchemaPath)

initMigrationManager

protected step.migration.MigrationManager initMigrationManager()

Initializes the migration manager with specific migrations used for yaml plan format

yamlPlanToPlan

protected Plan yamlPlanToPlan(YamlPlan yamlPlan)

planToYamlPlan

protected YamlPlan planToYamlPlan(Plan plan)