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

Interface Network

All Superinterfaces:

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

All Known Implementing Classes:

AbstractNetwork, BridgedNetwork, HostOnlyNetwork

public interface Network
extends com.oracle.bedrock.Option.Collectable

An Option representing a Network for 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

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>>

Method Summary

Modifier and Type	Method and Description
default Class<? extends com.oracle.bedrock.Option.Collector>	getCollectorClass()
String	getId() Obtain the identifier for the Network.
String	getMacAddress() Obtains the mac address for the Network.
boolean	isPublic() Determines if the Network is visible outside of the Virtual Machine represented by the VagrantPlatform.
Optional<com.oracle.bedrock.runtime.remote.options.HostName>	write(PrintWriter writer, String prefix, String padding) Write the configuration of the network to the specified PrintWriter, optionally returning the public hostname of the network if public.

Method Detail

getId

String getId()

Obtain the identifier for the Network.

For example: "eth1"

Returns:

the network identifier

isPublic

boolean isPublic()

Determines if the Network is visible outside of the Virtual Machine represented by the VagrantPlatform.

Returns:

true if the Network is visible outside fo the VagrantPlatform, false otherwise

getMacAddress

String getMacAddress()

Obtains the mac address for the Network.

Returns:

the mac address

write

Optional<com.oracle.bedrock.runtime.remote.options.HostName> write(PrintWriter writer,
                                                                   String prefix,
                                                                   String padding)

Write the configuration of the network to the specified PrintWriter, optionally returning the public hostname of the network if public.

Parameters:

writer - the PrintWriter

prefix - the prefix

padding - the padding

Returns:

the Optional HostName of the network interface (when applicable)

getCollectorClass

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

Specified by:

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