com.datastax.bdp.graph.api.model.config

Interface GraphConfigspace

All Superinterfaces:

java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.Object>>

All Known Subinterfaces:

GraphConfig

public interface GraphConfigspace
extends java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.Object>>

A namespace of configuration options within the graph GraphConfig. Contains configuration options which can be inspected and changed. Iterating over a GraphConfigspace returns all the configuration entries (i.e. configuration option identifiers and their associated value) that have been set within the space.

Method Summary

Modifier and Type	Method and Description
default boolean	contains(java.lang.String configOption)
java.lang.Object	get(java.lang.String configOption)
GraphConfigspace	set(java.lang.String configOption, java.lang.Object value) Sets the given configuration option to the provided value.
default GraphConfigspace	unset(java.lang.String configOption) Removes the given configuration option (and its associated value - if any) from this configuration space.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

contains

default boolean contains(java.lang.String configOption)

Parameters:

configOption - The string identifier of a configuration option within this Configspace

Returns:

True if the configuration contains the given configuration option

get

java.lang.Object get(java.lang.String configOption)

Parameters:

configOption - The string identifier of a configuration option within this Configspace

Returns:

The value of the configuration option if it has been set, else NULL

set

GraphConfigspace set(java.lang.String configOption,
                     java.lang.Object value)

Sets the given configuration option to the provided value. This changes the configuration but changes will not be applied until GraphConfig#applyChanges() is called. Make sure to call this method after all configuration changes have been made. *

Parameters:

configOption - The string identifier of a configuration option within this Configspace

value - The value to set the configuration option to

Returns:

This configuration space

Throws:

java.lang.IllegalArgumentException - If the provided value is invalid for the given option

unset

default GraphConfigspace unset(java.lang.String configOption)

Removes the given configuration option (and its associated value - if any) from this configuration space.

Parameters:

configOption - the name of the option

Returns:

This configuration space