Class DocusaurusFile

java.lang.Object

net.thevpc.commons.md.docusaurus.DocusaurusFile

All Implemented Interfaces:

DocusaurusFileOrFolder

public class DocusaurusFile
extends Object
implements DocusaurusFileOrFolder

Author:

thevpc

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	DocusaurusFile.Type

Method Summary

Modifier and Type	Method	Description
String	getContent()
String	getLongId()
int	getOrder()
Path	getPath()
String	getShortId()
String	getTitle()
MdElement	getTree()
DocusaurusFile.Type	getType()
boolean	isFile()
boolean	isFolder()
static DocusaurusFile	ofContent(String id, String longId, String title, String content, int menuOrder)
static DocusaurusFile	ofFile(Path path, Path root)
static DocusaurusFile	ofPath(String id, String longId, String title, Path path, int menuOrder)
static DocusaurusFile	ofTree(String id, String longId, String title, MdElement tree, int menuOrder)
String	toJSON(int indent)
String	toString()

Methods inherited from class Object

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

Method Details

ofContent

public static DocusaurusFile ofContent(String id,
 String longId,
 String title,
 String content,
 int menuOrder)

ofPath

public static DocusaurusFile ofPath(String id,
 String longId,
 String title,
 Path path,
 int menuOrder)

ofTree

public static DocusaurusFile ofTree(String id,
 String longId,
 String title,
 MdElement tree,
 int menuOrder)

ofFile

public static DocusaurusFile ofFile(Path path,
 Path root)

getOrder

public int getOrder()

Specified by:

getOrder in interface DocusaurusFileOrFolder

getType

public DocusaurusFile.Type getType()

getLongId

public String getLongId()

Specified by:

getLongId in interface DocusaurusFileOrFolder

getShortId

public String getShortId()

Specified by:

getShortId in interface DocusaurusFileOrFolder

getTitle

public String getTitle()

Specified by:

getTitle in interface DocusaurusFileOrFolder

getPath

public Path getPath()

getContent

public String getContent()

getTree

public MdElement getTree()

toString

public String toString()

Overrides:

toString in class Object

isFile

public boolean isFile()

Specified by:

isFile 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