org.cloudfoundry.operations.applications

Class ApplicationManifestUtilsV3

java.lang.Object

org.cloudfoundry.operations.applications.ApplicationManifestUtilsV3

public final class ApplicationManifestUtilsV3
extends Object

Utilities for dealing with ManifestV3s. Includes the functionality to transform to and from standard CLI YAML files.

Method Summary

Modifier and Type	Method and Description
static ManifestV3	read(Path path) Reads a YAML manifest file (defined by the CC API) from a Path and converts it into a ManifestV3 object.
static ManifestV3	read(Path path, Path variablesPath) Reads a YAML manifest file (defined by the CC API) from a Path and converts it into a ManifestV3 object.
static void	write(OutputStream out, ManifestV3 manifest) Write a ManifestV3 to an OutputStream
static void	write(Path path, ManifestV3 manifest) Write a ManifestV3 to a Path

Methods inherited from class java.lang.Object

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

Method Detail

read

public static ManifestV3 read(Path path)

Reads a YAML manifest file (defined by the CC API) from a Path and converts it into a ManifestV3 object. Note that all resolution (both inheritance and common) is performed during read.

Parameters:

path - the path to read from

Returns:

the resolved manifest

read

public static ManifestV3 read(Path path,
                              Path variablesPath)

Reads a YAML manifest file (defined by the CC API) from a Path and converts it into a ManifestV3 object. Note that all resolution (both inheritance and common) is performed during read.

Parameters:

path - the path to read from

variablesPath - use variable substitution (described in Add Variables to a Manifest)

Returns:

the resolved manifest

write

public static void write(Path path,
                         ManifestV3 manifest)

Write a ManifestV3 to a Path

Parameters:

path - the path to write to

manifest - the manifest to write

write

public static void write(OutputStream out,
                         ManifestV3 manifest)

Write a ManifestV3 to an OutputStream

Parameters:

out - the OutputStream to write to

manifest - the manifest to write