net.thevpc.nuts.toolbox.docusaurus

Class DocusaurusFolder

java.lang.Object

net.thevpc.nuts.toolbox.docusaurus.DocusaurusFolder

All Implemented Interfaces:

DocusaurusFileOrFolder

public class DocusaurusFolder
extends Object
implements DocusaurusFileOrFolder

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
DocusaurusFolder(String longId, String title, int order, net.thevpc.nuts.NutsObjectElement config, DocusaurusFileOrFolder[] children, net.thevpc.nuts.lib.md.MdElement tree, String path)

Method Summary

Modifier and Type	Method and 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()
net.thevpc.nuts.NutsObjectElement	getConfig()
net.thevpc.nuts.lib.md.MdElement	getContent(net.thevpc.nuts.NutsSession session)
DocusaurusFileOrFolder	getImmediate(String name, boolean required, NameResolver nameResolver)
String	getLongId()
int	getOrder()
DocusaurusFile	getPage(String path, boolean required, NameResolver nameResolver)
String	getPath()
String	getShortId()
String	getTitle()
boolean	isFile()
boolean	isFolder()
static DocusaurusFolder	of(String longId, String title, int order, net.thevpc.nuts.NutsObjectElement config, DocusaurusFileOrFolder[] children, String path)
static DocusaurusFileOrFolder	ofFileOrFolder(net.thevpc.nuts.NutsSession session, Path path, Path root, Path configRoot)
static DocusaurusFileOrFolder	ofFileOrFolder(net.thevpc.nuts.NutsSession session, Path path, Path root, Path configRoot, int maxDepth)
static DocusaurusFolder	ofFolder(net.thevpc.nuts.NutsSession session, Path path, Path root, Path configRoot, int maxDepth)
static DocusaurusFolder	ofRoot(net.thevpc.nuts.NutsSession session, DocusaurusFileOrFolder[] children, net.thevpc.nuts.lib.md.MdElement tree, String path)
String	toJSON(int indent)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

FOLDER_INFO_NAME

public static final String FOLDER_INFO_NAME

See Also:

Constant Field Values

DEFAULT_NAME_RESOLVER

public static final NameResolver DEFAULT_NAME_RESOLVER

DFOF_COMPARATOR

public static final Comparator<DocusaurusFileOrFolder> DFOF_COMPARATOR

Constructor Detail

DocusaurusFolder

public DocusaurusFolder(String longId,
                        String title,
                        int order,
                        net.thevpc.nuts.NutsObjectElement config,
                        DocusaurusFileOrFolder[] children,
                        net.thevpc.nuts.lib.md.MdElement tree,
                        String path)

Method Detail

getPath

public String getPath()

getContent

public net.thevpc.nuts.lib.md.MdElement getContent(net.thevpc.nuts.NutsSession session)

Specified by:

getContent in interface DocusaurusFileOrFolder

ofFileOrFolder

public static DocusaurusFileOrFolder ofFileOrFolder(net.thevpc.nuts.NutsSession session,
                                                    Path path,
                                                    Path root,
                                                    Path configRoot)

ofFileOrFolder

public static DocusaurusFileOrFolder ofFileOrFolder(net.thevpc.nuts.NutsSession session,
                                                    Path path,
                                                    Path root,
                                                    Path configRoot,
                                                    int maxDepth)

ofFolder

public static DocusaurusFolder ofFolder(net.thevpc.nuts.NutsSession session,
                                        Path path,
                                        Path root,
                                        Path configRoot,
                                        int maxDepth)

ofRoot

public static DocusaurusFolder ofRoot(net.thevpc.nuts.NutsSession session,
                                      DocusaurusFileOrFolder[] children,
                                      net.thevpc.nuts.lib.md.MdElement tree,
                                      String path)

of

public static DocusaurusFolder of(String longId,
                                  String title,
                                  int order,
                                  net.thevpc.nuts.NutsObjectElement config,
                                  DocusaurusFileOrFolder[] children,
                                  String path)

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 net.thevpc.nuts.NutsObjectElement getConfig()

toString

public String toString()

Overrides:

toString in class Object