Class DocusaurusFolder

java.lang.Object

net.thevpc.commons.md.docusaurus.DocusaurusFolder

All Implemented Interfaces:

DocusaurusFileOrFolder

public class DocusaurusFolder
extends Object
implements DocusaurusFileOrFolder

Field Summary

Fields

Modifier and Type	Field	Description
static final NameResolver	DEFAULT_NAME_RESOLVER
static final Comparator<DocusaurusFileOrFolder>	DFOF_COMPARATOR

Constructor Summary

Constructors

Constructor	Description
DocusaurusFolder(String longId, String title, int order, LJSON config, DocusaurusFileOrFolder[] children)

Method Summary

Modifier and Type	Method	Description
Stream<DocusaurusFileOrFolder>	children()
DocusaurusFileOrFolder	get(String[] pathArray, boolean required, NameResolver nameResolver)
DocusaurusFileOrFolder	get(String path, boolean required, NameResolver nameResolver)
DocusaurusFileOrFolder[]	getAllImmediate(String name, NameResolver nameResolver)
DocusaurusFileOrFolder[]	getChildren()
LJSON	getConfig()
DocusaurusFileOrFolder	getImmediate(String name, boolean required, NameResolver nameResolver)
String	getLongId()
int	getOrder()
DocusaurusFile	getPage(String path, boolean required, NameResolver nameResolver)
String	getShortId()
String	getTitle()
boolean	isFile()
boolean	isFolder()
static DocusaurusFolder	of(String longId, String title, int order, LJSON config, DocusaurusFileOrFolder... children)
static DocusaurusFileOrFolder	ofFileOrFolder(Path path, Path root)
static DocusaurusFileOrFolder	ofFileOrFolder(Path path, Path root, int maxDepth)
static DocusaurusFolder	ofFolder(Path path, Path root, int maxDepth)
static DocusaurusFolder	ofRoot(DocusaurusFileOrFolder... children)
String	toJSON(int indent)
String	toString()

Methods inherited from class Object

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

Field Details

DEFAULT_NAME_RESOLVER

public static final NameResolver DEFAULT_NAME_RESOLVER

DFOF_COMPARATOR

public static final Comparator<DocusaurusFileOrFolder> DFOF_COMPARATOR

Constructor Details

DocusaurusFolder

public DocusaurusFolder(String longId,
 String title,
 int order,
 LJSON config,
 DocusaurusFileOrFolder[] children)

Method Details

ofFileOrFolder

public static DocusaurusFileOrFolder ofFileOrFolder(Path path,
 Path root)

ofFileOrFolder

public static DocusaurusFileOrFolder ofFileOrFolder(Path path,
 Path root,
 int maxDepth)

ofFolder

public static DocusaurusFolder ofFolder(Path path,
 Path root,
 int maxDepth)

ofRoot

public static DocusaurusFolder ofRoot(DocusaurusFileOrFolder... children)

of

public static DocusaurusFolder of(String longId,
 String title,
 int order,
 LJSON config,
 DocusaurusFileOrFolder... children)

getShortId

public String getShortId()

Specified by:

getShortId in interface DocusaurusFileOrFolder

getLongId

public String getLongId()

Specified by:

getLongId in interface DocusaurusFileOrFolder

getTitle

public String getTitle()

Specified by:

getTitle in interface DocusaurusFileOrFolder

isFile

public boolean isFile()

Specified by:

isFile in interface DocusaurusFileOrFolder

getOrder

public int getOrder()

Specified by:

getOrder in interface DocusaurusFileOrFolder

isFolder

public boolean isFolder()

Specified by:

isFolder in interface DocusaurusFileOrFolder

toJSON

public String toJSON(int indent)

Specified by:

toJSON in interface DocusaurusFileOrFolder

getImmediate

public DocusaurusFileOrFolder getImmediate(String name,
 boolean required,
 NameResolver nameResolver)

getAllImmediate

public DocusaurusFileOrFolder[] getAllImmediate(String name,
 NameResolver nameResolver)

getPage

public DocusaurusFile getPage(String path,
 boolean required,
 NameResolver nameResolver)

get

public DocusaurusFileOrFolder get(String path,
 boolean required,
 NameResolver nameResolver)

get

public DocusaurusFileOrFolder get(String[] pathArray,
 boolean required,
 NameResolver nameResolver)

children

public Stream<DocusaurusFileOrFolder> children()

getChildren

public DocusaurusFileOrFolder[] getChildren()

getConfig

public LJSON getConfig()

toString

public String toString()

Overrides:

toString in class Object