com.google.cloud.tools.jib.plugins.common

Class SkaffoldFilesOutput

java.lang.Object

com.google.cloud.tools.jib.plugins.common.SkaffoldFilesOutput

public class SkaffoldFilesOutput
extends Object

Builds a JSON string containing files and directories that Skaffold should watch for changes (and consequently trigger rebuilds).

build consists of build definitions. Changes in these files/directories indicate that the project structure may have changed, so Skaffold will refresh the file watch list when this happens.

inputs consist of source/resource files/directories. Skaffold will trigger a rebuild when changes are detected in these files.

ignore consists of files/directories that the Skaffold file watcher should not watch.

Example:

 {
   "build": [
     "buildFile1",
     "buildFile2"
   ],
   "inputs": [
     "src/main/java/",
     "src/main/resources/"
   ],
   "ignore": [
     "pathToIgnore"
   ]
 }
 

Constructor Summary

Constructors

Constructor and Description
SkaffoldFilesOutput() Creates an empty SkaffoldFilesOutput.
SkaffoldFilesOutput(String json) Creates a SkaffoldFilesOutput from a JSON string.

Method Summary

Modifier and Type	Method and Description
void	addBuild(Path build) Adds a build file/directory.
void	addIgnore(Path ignoreFile) Adds an ignored file/directory.
void	addInput(Path inputFile) Adds an input file/directory.
List<String>	getBuild()
List<String>	getIgnore()
List<String>	getInputs()
String	getJsonString() Gets the added files in JSON format.

Methods inherited from class java.lang.Object

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

Constructor Detail

SkaffoldFilesOutput

public SkaffoldFilesOutput()

Creates an empty SkaffoldFilesOutput.

SkaffoldFilesOutput

public SkaffoldFilesOutput(String json)
                    throws IOException

Creates a SkaffoldFilesOutput from a JSON string.

Parameters:

json - the JSON string

Throws:

IOException - if reading the JSON string fails

Method Detail

addBuild

public void addBuild(Path build)

Adds a build file/directory.

Parameters:

build - the path to the file/directory

addInput

public void addInput(Path inputFile)

Adds an input file/directory.

Parameters:

inputFile - the path to the file/directory

addIgnore

public void addIgnore(Path ignoreFile)

Adds an ignored file/directory.

Parameters:

ignoreFile - the path to the file/directory

getBuild

public List<String> getBuild()

getInputs

public List<String> getInputs()

getIgnore

public List<String> getIgnore()

getJsonString

public String getJsonString()
                     throws IOException

Gets the added files in JSON format.

Returns:

the files in a JSON string

Throws:

IOException - if writing out the JSON fails