org.testingisdocumenting.znai.website

Class WebSite

java.lang.Object

org.testingisdocumenting.znai.website.WebSite

All Implemented Interfaces:

Log

public class WebSite
extends Object
implements Log

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebSite.Configuration

Method Summary

Modifier and Type	Method and Description
Set<TocItem>	dependentTocItems(Path auxiliaryFile)
void	deploy()
AuxiliaryFilesRegistry	getAuxiliaryFilesRegistry()
WebSite.Configuration	getCfg()
Path	getDeployRoot()
DocMeta	getDocMeta()
Map<String,Path>	getOutsideDocsRequestedResources()
ReactJsBundle	getReactJsBundle()
TableOfContents	getToc()
void	info(Object... styleOrValue)
void	parse()
void	parseAndDeploy()
Footer	parseFooter()
void	phase(String message)
void	redeployAuxiliaryFileIfRequired(Path path)
void	regenerate()
HtmlPageAndPageProps	regenerateAndValidatePageDeployTocAndAllPages(TocItem tocItem)
HtmlPageAndPageProps	regeneratePageOnly(TocItem tocItem)
void	removeLinksForTocItem(TocItem tocItem)
TocItem	tocItemByPath(Path path)
DocReferences	updateDocReferences()
TocAddedAndRemovedPages	updateToc()
void	warn(String message)
static WebSite.Configuration	withRoot(Path path)

Methods inherited from class java.lang.Object

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

Method Detail

getCfg

public WebSite.Configuration getCfg()

withRoot

public static WebSite.Configuration withRoot(Path path)

regenerate

public void regenerate()

getAuxiliaryFilesRegistry

public AuxiliaryFilesRegistry getAuxiliaryFilesRegistry()

getDeployRoot

public Path getDeployRoot()

getDocMeta

public DocMeta getDocMeta()

getReactJsBundle

public ReactJsBundle getReactJsBundle()

getOutsideDocsRequestedResources

public Map<String,Path> getOutsideDocsRequestedResources()

parseAndDeploy

public void parseAndDeploy()

parse

public void parse()

deploy

public void deploy()

tocItemByPath

public TocItem tocItemByPath(Path path)

regenerateAndValidatePageDeployTocAndAllPages

public HtmlPageAndPageProps regenerateAndValidatePageDeployTocAndAllPages(TocItem tocItem)

removeLinksForTocItem

public void removeLinksForTocItem(TocItem tocItem)

regeneratePageOnly

public HtmlPageAndPageProps regeneratePageOnly(TocItem tocItem)

dependentTocItems

public Set<TocItem> dependentTocItems(Path auxiliaryFile)

getToc

public TableOfContents getToc()

updateToc

public TocAddedAndRemovedPages updateToc()

updateDocReferences

public DocReferences updateDocReferences()

parseFooter

public Footer parseFooter()

redeployAuxiliaryFileIfRequired

public void redeployAuxiliaryFileIfRequired(Path path)

phase

public void phase(String message)

Specified by:

phase in interface Log

info

public void info(Object... styleOrValue)

Specified by:

info in interface Log

warn

public void warn(String message)

Specified by:

warn in interface Log