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

Class VagrantProperties

java.lang.Object

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

All Implemented Interfaces:

com.oracle.bedrock.Option, com.oracle.bedrock.Option.Collector<VagrantProperty,VagrantProperties>, Iterable<VagrantProperty>

public class VagrantProperties
extends Object
implements com.oracle.bedrock.Option.Collector<VagrantProperty,VagrantProperties>

A Collector of VagrantPropertys.

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

Constructor Summary

Constructors

Constructor and Description
VagrantProperties() Constructs an empty VagrantProperties.
VagrantProperties(Map<String,String> properties) Constructs a VagrantProperties with properties based on a Map of name-value pairs.
VagrantProperties(Properties properties) Constructs a VagrantProperties based on a standard Properties representation.
VagrantProperties(VagrantProperties vagrantProperties) Constructs a VagrantProperties based on the properties defined in another VagrantProperties.
VagrantProperties(VagrantProperty... properties) Constructs a VagrantProperties based on the properties defined in another VagrantProperties.

Method Summary

Modifier and Type	Method and Description
VagrantProperties	add(VagrantProperty... properties) Adds the specified VagrantProperty to the VagrantProperties, returning a new VagrantProperties containing the VagrantProperty.
VagrantProperties	addAll(Map<String,Object> properties) Adds all of the specified properties represented as a Map of name-value pairs as individual VagrantPropertys, returning a new VagrantProperties.
VagrantProperties	addAll(VagrantProperties properties) Adds all of the VagrantProperties to this VagrantProperties returning a new VagrantProperties.
VagrantProperties	addIfAbsent(VagrantProperty property) Adds the specified VagrantProperty to the VagrantProperties, returning a new VagrantProperties containing the VagrantProperty (if and only if a VagrantProperty with the same name doesn't already exist).
boolean	contains(String propertyName) Determines if the VagrantProperties contains a VagrantProperty with the specified name.
boolean	equals(Object o)
VagrantProperty	get(String propertyName) Obtains the VagrantProperty with the specified name, returning null if one is not found.
<O> Iterable<O>	getInstancesOf(Class<O> requiredClass)
Object	getProperty(String name) Obtains the current value of the specified VagrantProperty.
int	hashCode()
boolean	isEmpty() Determines if the VagrantProperties is empty (contains no VagrantPropertys)
Iterator<VagrantProperty>	iterator()
VagrantProperties	remove(String propertyName) Removes the specified VagrantProperty named property from the VagrantProperties, returning a new VagrantProperties without the said VagrantProperty.
int	size() Obtains the number of VagrantPropertys contained by the VagrantProperties.
VagrantProperties	with(VagrantProperty property)
VagrantProperties	without(VagrantProperty property)
void	write(PrintWriter writer, String sPrefix, String sPad) Writes the VagrantProperties to the specified PrintWriter.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

VagrantProperties

@OptionsByType.Default
public VagrantProperties()

Constructs an empty VagrantProperties.

VagrantProperties

public VagrantProperties(Map<String,String> properties)

Constructs a VagrantProperties with properties based on a Map of name-value pairs.

Parameters:

properties - the Map of properties to use as the basis for the VagrantProperties

VagrantProperties

public VagrantProperties(Properties properties)

Constructs a VagrantProperties based on a standard Properties representation.

Parameters:

properties - the Properties to use as the basis for the VagrantProperties

VagrantProperties

public VagrantProperties(VagrantProperties vagrantProperties)

Constructs a VagrantProperties based on the properties defined in another VagrantProperties.

Parameters:

vagrantProperties - the VagrantProperties on which to base the new VagrantProperties

VagrantProperties

public VagrantProperties(VagrantProperty... properties)

Constructs a VagrantProperties based on the properties defined in another VagrantProperties.

Parameters:

properties - the VagrantProperties on which to base the new VagrantProperties

Method Detail

size

public int size()

Obtains the number of VagrantPropertys contained by the VagrantProperties.

Returns:

the number of VagrantPropertys

isEmpty

public boolean isEmpty()

Determines if the VagrantProperties is empty (contains no VagrantPropertys)

Returns:

true if the VagrantProperties is empty, false otherwise

add

public VagrantProperties add(VagrantProperty... properties)

Adds the specified VagrantProperty to the VagrantProperties, returning a new VagrantProperties containing the VagrantProperty.

Parameters:

properties - the VagrantPropertys to add

Returns:

the a new VagrantProperties instance, including the existing VagrantPropertys and the new VagrantProperty

addIfAbsent

public VagrantProperties addIfAbsent(VagrantProperty property)

Adds the specified VagrantProperty to the VagrantProperties, returning a new VagrantProperties containing the VagrantProperty (if and only if a VagrantProperty with the same name doesn't already exist).

Parameters:

property - the VagrantProperty to add

Returns:

the a new VagrantProperties instance, including the existing VagrantPropertys and the new VagrantProperty

remove

public VagrantProperties remove(String propertyName)

Removes the specified VagrantProperty named property from the VagrantProperties, returning a new VagrantProperties without the said VagrantProperty.

Parameters:

propertyName - the VagrantProperty to remove

Returns:

the a new VagrantProperties instance, excluding the specified VagrantProperty

addAll

public VagrantProperties addAll(Map<String,Object> properties)

Adds all of the specified properties represented as a Map of name-value pairs as individual VagrantPropertys, returning a new VagrantProperties.

Parameters:

properties - the Map of properties

Returns:

a new VagrantProperties

addAll

public VagrantProperties addAll(VagrantProperties properties)

Adds all of the VagrantProperties to this VagrantProperties returning a new VagrantProperties.

Parameters:

properties - the VagrantProperties

Returns:

a new VagrantProperties

contains

public boolean contains(String propertyName)

Determines if the VagrantProperties contains a VagrantProperty with the specified name.

Parameters:

propertyName - the name of the VagrantProperty

Returns:

true if the VagrantProperties contains a VagrantProperty with the specified name, false otherwise

get

public VagrantProperty get(String propertyName)

Obtains the VagrantProperty with the specified name, returning null if one is not found.

Parameters:

propertyName - the name of the desired VagrantProperty

Returns:

the VagrantProperty of null if not defined

getProperty

public Object getProperty(String name)

Obtains the current value of the specified VagrantProperty. If the property has a value specified, that value will be used. If the property is unknown, null will be returned.

Parameters:

name - the name of the property

Returns:

an Object

with

public VagrantProperties with(VagrantProperty property)

Specified by:

with in interface com.oracle.bedrock.Option.Collector<VagrantProperty,VagrantProperties>

without

public VagrantProperties without(VagrantProperty property)

Specified by:

without in interface com.oracle.bedrock.Option.Collector<VagrantProperty,VagrantProperties>

getInstancesOf

public <O> Iterable<O> getInstancesOf(Class<O> requiredClass)

Specified by:

getInstancesOf in interface com.oracle.bedrock.Option.Collector<VagrantProperty,VagrantProperties>

iterator

public Iterator<VagrantProperty> iterator()

Specified by:

iterator in interface Iterable<VagrantProperty>

write

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

Writes the VagrantProperties to the specified PrintWriter.

Parameters:

writer - the PrintWriter

sPrefix - the prefix for each property

sPad - the padding for each property

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object