com.cloudbees.clickstack.domain.metadata

Class Metadata.Builder

java.lang.Object

com.cloudbees.clickstack.domain.metadata.Metadata.Builder

Enclosing class:

Metadata

public static class Metadata.Builder
extends Object

The Builder class creates a new Metadata instance from a metadata.json file.

Constructor Summary

Constructors

Constructor and Description
Metadata.Builder()

Method Summary

Methods

Modifier and Type	Method and Description
static Metadata	fromFile(File metadataFile) This method parses a metadata.json file and returns a new Metadata instance containing the metadata that has been parsed.
static Metadata	fromFile(Path metadataFile)
static Metadata	fromJson(com.fasterxml.jackson.databind.JsonNode metadataRootNode) This method is called from the fromStream method to parse json from a stream.
static Metadata	fromJsonString(String metadata, boolean allowSingleQuotes) This method is called from the fromStream method to parse json from a stream.
static Metadata	fromStream(InputStream metadataInputStream) This method is called from the fromFile method to parse json from a stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

Metadata.Builder

public Metadata.Builder()

Method Detail

fromFile

public static Metadata fromFile(File metadataFile)
                         throws IOException

This method parses a metadata.json file and returns a new Metadata instance containing the metadata that has been parsed.

Parameters:

metadataFile - The absolute path to the metadata.json file to be parsed.

Returns:

A new Metadata instance, containing the parameters from the metadata.json file.

Throws:

IOException

fromFile

public static Metadata fromFile(@Nonnull
                Path metadataFile)
                         throws IOException

Throws:

IOException

fromStream

public static Metadata fromStream(InputStream metadataInputStream)
                           throws IOException

This method is called from the fromFile method to parse json from a stream.

Parameters:

metadataInputStream - An InputStream to read the JSON metadata from.

Returns:

A new Metadata instance, containing all resources parsed from the JSON metadata given as input.

Throws:

IOException

fromJson

public static Metadata fromJson(com.fasterxml.jackson.databind.JsonNode metadataRootNode)
                         throws IOException

This method is called from the fromStream method to parse json from a stream.

Parameters:

metadataRootNode - the JSON metadata from.

Returns:

A new Metadata instance, containing all resources parsed from the JSON metadata given as input.

Throws:

IOException

fromJsonString

public static Metadata fromJsonString(String metadata,
                      boolean allowSingleQuotes)
                               throws IOException

This method is called from the fromStream method to parse json from a stream.

Parameters:

metadata - the JSON metadata.

Returns:

A new Metadata instance, containing all resources parsed from the JSON metadata given as input.

Throws:

IOException