Package com.mohamnag.jstatic.plugins.yaml_loader

Class YamlLoaderTask

java.lang.Object

com.mohamnag.jstatic.plugins.AbstractDirectoryCrawler

com.mohamnag.jstatic.plugins.yaml_loader.YamlLoaderTask

All Implemented Interfaces:

BuildTask

public class YamlLoaderTask
extends AbstractDirectoryCrawler
implements BuildTask

Loads data from YAML files into DataTree. On each directory, if a file named "data.yaml" is found, it will be loaded and put into

invalid reference

DataNode#getData()

with same path on data tree.

All other files with extension ".yaml", will be put as DataPage into the tree. If a page already exists with that path, data will be merged.

Constructor Summary

Constructors

Constructor	Description
YamlLoaderTask(Config globalConfig)

Method Summary

Modifier and Type	Method	Description
void	run(BuildContext buildContext)
List<Path>	underWatchConfigPaths()	If a plugin depends on config files in addition to the general config file of the application, like functionality extensions stored in files, it shall return these paths here.
List<Path>	underWatchInputPaths()	If a plugin depends on file input, it shall return list of its input paths to be watched for changes.

Methods inherited from class com.mohamnag.jstatic.plugins.AbstractDirectoryCrawler

extractPathElements, getPageName

Methods inherited from class java.lang.Object

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

Constructor Details

YamlLoaderTask

public YamlLoaderTask(Config globalConfig)

Method Details

run

public void run(BuildContext buildContext)

Specified by:

run in interface BuildTask

underWatchInputPaths

public List<Path> underWatchInputPaths()

Description copied from interface: BuildTask

If a plugin depends on file input, it shall return list of its input paths to be watched for changes. Paths can be either files or directories. In case of directories, only root path are necessary to be listed and if input path has subdirectories, they will be automatically watched.

Specified by:

underWatchInputPaths in interface BuildTask

underWatchConfigPaths

public List<Path> underWatchConfigPaths()

Description copied from interface: BuildTask

If a plugin depends on config files in addition to the general config file of the application, like functionality extensions stored in files, it shall return these paths here. A change detected in these paths will result in recreation of the plugin.

Specified by:

underWatchConfigPaths in interface BuildTask