com.netflix.nicobar.core.archive

Class PathScriptArchive.Builder

java.lang.Object

com.netflix.nicobar.core.archive.PathScriptArchive.Builder

Enclosing class:

PathScriptArchive

public static class PathScriptArchive.Builder
extends java.lang.Object

Used to Construct a PathScriptArchive.

 Default settings:
 * generate a moduleId using the last element of the Path
 * all files under the root path will be included in the archive.
 * searches for a module spec file under the root directory called "moduleSpec.json" and
   uses the GsonScriptModuleSpecSerializer to deserialize it.
 

Constructor Summary

Constructors

Constructor and Description
PathScriptArchive.Builder(java.nio.file.Path rootDirPath) Start a builder with required parameters.

Method Summary

Methods

Modifier and Type	Method and Description
PathScriptArchive.Builder	addFile(java.nio.file.Path file) Append a single file to the archive
PathScriptArchive	build() Build the PathScriptArchive.
PathScriptArchive.Builder	setCreateTime(long createTime) Set the creation time
PathScriptArchive.Builder	setModuleSpec(ScriptModuleSpec moduleSpec) Set the module spec for this archive
PathScriptArchive.Builder	setModuleSpecSerializer(ScriptModuleSpecSerializer specSerializer) override the default module spec file name
PathScriptArchive.Builder	setRecurseRoot(boolean recurseRoot) If true, then add all of the files underneath the root path.

Methods inherited from class java.lang.Object

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

Constructor Detail

PathScriptArchive.Builder

public PathScriptArchive.Builder(java.nio.file.Path rootDirPath)

Start a builder with required parameters.

Parameters:

rootDirPath - absolute path to the root directory to recursively add

Method Detail

setRecurseRoot

public PathScriptArchive.Builder setRecurseRoot(boolean recurseRoot)

If true, then add all of the files underneath the root path. default is true

setModuleSpec

public PathScriptArchive.Builder setModuleSpec(ScriptModuleSpec moduleSpec)

Set the module spec for this archive

setModuleSpecSerializer

public PathScriptArchive.Builder setModuleSpecSerializer(ScriptModuleSpecSerializer specSerializer)

override the default module spec file name

addFile

public PathScriptArchive.Builder addFile(java.nio.file.Path file)

Append a single file to the archive

Parameters:

file - relative path from the root

setCreateTime

public PathScriptArchive.Builder setCreateTime(long createTime)

Set the creation time

build

public PathScriptArchive build()
                        throws java.io.IOException

Build the PathScriptArchive.

Throws:

java.io.IOException