Class DocsNameSpaceImpl

java.lang.Object

io.nosqlbench.nb.api.docsapi.DocsNameSpaceImpl

All Implemented Interfaces:

DocsNameSpace, Iterable<Path>

public class DocsNameSpaceImpl
extends Object
implements DocsNameSpace

Constructor Summary

Constructors

Constructor	Description
DocsNameSpaceImpl()
DocsNameSpaceImpl(String name)

Method Summary

Modifier and Type	Method	Description
DocsNameSpaceImpl	addPath(Path path)
DocsNameSpaceImpl	enabledByDefault()
String	getName()	A simple name which can be used to nest the enclosed path within a larger namespace.
List<Path>	getPaths()
boolean	isEnabledByDefault()
Iterator<Path>	iterator()
static DocsNameSpaceImpl	of(String descriptiveName, Path path)
DocsNameSpaceImpl	setEnabledByDefault(boolean enabledByDefault)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

DocsNameSpaceImpl

public DocsNameSpaceImpl()

DocsNameSpaceImpl

public DocsNameSpaceImpl(String name)

Method Details

of

public static DocsNameSpaceImpl of(String descriptiveName,
 Path path)

getName

public String getName()

Description copied from interface: DocsNameSpace

A simple name which can be used to nest the enclosed path within a larger namespace. Users of this interface should never host content from the path at a root level separate from the namespace.

Specified by:

getName in interface DocsNameSpace

Returns:

A canonical namespace identifier

getPaths

public List<Path> getPaths()

Specified by:

getPaths in interface DocsNameSpace

isEnabledByDefault

public boolean isEnabledByDefault()

Specified by:

isEnabledByDefault in interface DocsNameSpace

toString

public String toString()

Overrides:

toString in class Object

addPath

public DocsNameSpaceImpl addPath(Path path)

enabledByDefault

public DocsNameSpaceImpl enabledByDefault()

iterator

public Iterator<Path> iterator()

Specified by:

iterator in interface Iterable<Path>

setEnabledByDefault

public DocsNameSpaceImpl setEnabledByDefault(boolean enabledByDefault)