Interface DocsNameSpace

All Superinterfaces:

Iterable<Path>

All Known Implementing Classes:

DocsNameSpaceImpl

public interface DocsNameSpace
extends Iterable<Path>

Doc Path Info represents a readable Path which is part of a well-known namespace.

 docpathinfo = {
     'namespace': 'example-namespace',
     'paths': ['path1', 'path2']
 }

 

When callers are using doc paths from this interface, it is an error for there to be multiple instance of a doc path of the same name in the same namespace. As long as the root path of a doc tree is unique within the given namespaces, they may be merged. This is to allow multiple contributors of detailed docs to a single known namespace.

Method Summary

Modifier and Type	Method	Description
String	getName()	A simple name which can be used to nest the enclosed path within a larger namespace.
List<Path>	getPaths()
boolean	isEnabledByDefault()

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Details

getName

String getName()

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.

Returns:

A canonical namespace identifier

getPaths

List<Path> getPaths()

isEnabledByDefault

boolean isEnabledByDefault()