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

Class VagrantProperty

java.lang.Object

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

All Implemented Interfaces:

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

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

A Collectable Option representing a Vagrant Property, consisting of a name and value.

Values of a VagrantProperty may be more than simple Strings. For example, if they are an Iterator, the value of a Vagrant Property will be the next value taken from the Iterator.

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

Author:

Brian Oliver

See Also:

VagrantProperties

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
Class<VagrantProperties>	getCollectorClass()
String	getName() Obtains the name of the VagrantProperty.
Object	getValue() Obtains the value of the VagrantProperty.
static VagrantProperty	of(String name, Iterator iterator) Constructs a VagrantProperty.
static VagrantProperty	of(String name, Object object) Constructs a VagrantProperty.
static VagrantProperty	of(String name, String value) Constructs a VagrantProperty.
String	toString()
void	write(PrintWriter writer, String sPrefix, String sPad) Writes the VagrantProperty to the specified PrintWriter.

Methods inherited from class java.lang.Object

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

Method Detail

of

public static VagrantProperty of(String name,
                                 String value)

Constructs a VagrantProperty.

Parameters:

name - the name of the VagrantProperty

value - the value of the VagrantProperty

Returns:

a VagrantProperty

of

public static VagrantProperty of(String name,
                                 Iterator iterator)

Constructs a VagrantProperty.

Parameters:

name - the name of the VagrantProperty

iterator - the iterator that can provide values for the VagrantProperty

Returns:

a VagrantProperty

of

public static VagrantProperty of(String name,
                                 Object object)

Constructs a VagrantProperty.

Parameters:

name - the name of the VagrantProperty

object - the values for the VagrantProperty

Returns:

a VagrantProperty

getName

public String getName()

Obtains the name of the VagrantProperty.

Returns:

the name of the VagrantProperty

getValue

public Object getValue()

Obtains the value of the VagrantProperty.

Returns:

the value of the VagrantProperty

write

public void write(PrintWriter writer,
                  String sPrefix,
                  String sPad)

Writes the VagrantProperty to the specified PrintWriter.

Parameters:

writer - the PrintWriter

sPrefix - the prefix for property

sPad - the padding for the property

toString

public String toString()

Overrides:

toString in class Object

getCollectorClass

public Class<VagrantProperties> getCollectorClass()

Specified by:

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