com.oracle.bedrock.runtime.virtual.vagrant

Interface VagrantFileBuilder

public interface VagrantFileBuilder

Builds a VagrantFile that can be used to establish a VagrantPlatform.

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

Author:

Brian Oliver

Method Summary

Modifier and Type	Method and Description
Optional<com.oracle.bedrock.runtime.remote.options.HostName>	create(File file, com.oracle.bedrock.OptionsByType optionsByType) Creates a Vagrant File containing Vagrant Configuration at the name and location specified by the provided File, returning the public HostName detected during creation of the file.
static VagrantFileBuilder	from(com.oracle.bedrock.Option... options) Obtains a VagrantFileBuilder that will be produced based on the specified Options.
static VagrantFileBuilder	from(URL vagrantFileTemplate) Obtains a VagrantFileBuilder that will be produced based on a template.

Method Detail

create

Optional<com.oracle.bedrock.runtime.remote.options.HostName> create(File file,
                                                                    com.oracle.bedrock.OptionsByType optionsByType)
                                                             throws IOException

Creates a Vagrant File containing Vagrant Configuration at the name and location specified by the provided File, returning the public HostName detected during creation of the file.

Parameters:

file - the File in which the Vagrant Configuration will be written

optionsByType - the OptionsByType for creating the file

Returns:

the detected HostName (when available)

Throws:

IOException - when the File could not be created

from

static VagrantFileBuilder from(URL vagrantFileTemplate)

Obtains a VagrantFileBuilder that will be produced based on a template.

Parameters:

vagrantFileTemplate - the URL of the Vagrant File template

Returns:

a VagrantFileBuilder

from

static VagrantFileBuilder from(com.oracle.bedrock.Option... options)

Obtains a VagrantFileBuilder that will be produced based on the specified Options.

Parameters:

options - the Options

Returns:

a VagrantFileBuilder

See Also:

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