com.oracle.bedrock.runtime.virtual.vagrant.options

Class VagrantProvisioner

java.lang.Object

com.oracle.bedrock.runtime.virtual.vagrant.options.VagrantProvisioner

All Implemented Interfaces:

com.oracle.bedrock.Option, com.oracle.bedrock.Option.Collectable

public class VagrantProvisioner
extends Object
implements com.oracle.bedrock.Option.Collectable

A representation of a Vagrant provisioner configuration.

Copyright (c) 2016. All Rights Reserved. Oracle Corporation.
Oracle is a registered trademark of Oracle Corporation and/or its affiliates.

Author:

Jonathan Knight

Nested Class Summary

Nested classes/interfaces inherited from interface com.oracle.bedrock.Option

com.oracle.bedrock.Option.Collectable, com.oracle.bedrock.Option.Collector<C extends com.oracle.bedrock.Option.Collectable,T extends com.oracle.bedrock.Option.Collector<C,T>>

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	runAlways Whether this VagrantProvisioner is always run

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	VagrantProvisioner(String type, String configuration) Create a new VagrantProvisioner of the specified type.

Method Summary

Modifier and Type	Method and Description
static VagrantProvisioner	custom(String type, String configuraton) Create an custom VagrantProvisioner.
boolean	equals(Object o)
static VagrantProvisioner	file(String source, String destination) Create a file copy VagrantProvisioner.
Class<? extends com.oracle.bedrock.Option.Collector>	getCollectorClass()
int	hashCode()
static VagrantProvisioner	inlineShell(String cmd) Create an in-line shell VagrantProvisioner.
boolean	isRunAlways() Determine whether this VagrantProvisioner should always run when a VagrantPlatform is started.
VagrantProvisioner	runAlways() Run this provisoner every time the Vagrant box is started.
VagrantProvisioner	runOnce() Only run this provisoner when the Vagrant box is first started.
void	write(PrintWriter writer, String prefix, String padding) Write the configuration of this VagrantProvisioner to a PrintWriter.

Methods inherited from class java.lang.Object

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

Field Detail

runAlways

protected boolean runAlways

Whether this VagrantProvisioner is always run

Constructor Detail

VagrantProvisioner

protected VagrantProvisioner(String type,
                             String configuration)

Create a new VagrantProvisioner of the specified type.

Parameters:

type - the type of this VagrantProvisioner

configuration - the configuration of the VagrantProvisioner

Method Detail

isRunAlways

public boolean isRunAlways()

Determine whether this VagrantProvisioner should always run when a VagrantPlatform is started.

Returns:

true if the provisioner always runs or false if it only runs on machine creation.

runAlways

public VagrantProvisioner runAlways()

Run this provisoner every time the Vagrant box is started.

Returns:

this VagrantProvisioner for fluent method chaining

runOnce

public VagrantProvisioner runOnce()

Only run this provisoner when the Vagrant box is first started.

Returns:

this VagrantProvisioner for fluent method chaining

write

public void write(PrintWriter writer,
                  String prefix,
                  String padding)

Write the configuration of this VagrantProvisioner to a PrintWriter.

Parameters:

writer - the PrintWriter

prefix - the prefix to write before each configuration

padding - the padding to write before each line

getCollectorClass

public Class<? extends com.oracle.bedrock.Option.Collector> getCollectorClass()

Specified by:

getCollectorClass in interface com.oracle.bedrock.Option.Collectable

inlineShell

public static VagrantProvisioner inlineShell(String cmd)

Create an in-line shell VagrantProvisioner.

Parameters:

cmd - the shell command to execute

Returns:

an in-line shell VagrantProvisioner

file

public static VagrantProvisioner file(String source,
                                      String destination)

Create a file copy VagrantProvisioner.

Parameters:

source - the source file to copy

destination - the destination to copy the file to

Returns:

an in-line shell VagrantProvisioner

custom

public static VagrantProvisioner custom(String type,
                                        String configuraton)

Create an custom VagrantProvisioner.

Parameters:

type - the Vagrant provisioner type

configuraton - the configuration to write for the provisioner

Returns:

an in-line shell VagrantProvisioner

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object