A B C D E F G H I J L M N O P R S T U V W Z

A

AbstractTemplateEngine - Class in org.jbake.template

A template is responsible for converting a model into a rendered document.

AbstractTemplateEngine(CompositeConfiguration, ContentStore, File, File) - Constructor for class org.jbake.template.AbstractTemplateEngine

addDocumentType(String) - Static method in class org.jbake.model.DocumentTypes

ARCHIVE_FILE - Static variable in interface org.jbake.app.ConfigUtil.Keys

Output filename for archive file, is only used when ConfigUtil.Keys.RENDER_ARCHIVE is true

ASCIIDOCTOR_ATTRIBUTES - Static variable in interface org.jbake.app.ConfigUtil.Keys

Asciidoctor attributes to be set when processing input

ASCIIDOCTOR_ATTRIBUTES_EXPORT - Static variable in interface org.jbake.app.ConfigUtil.Keys

Flag indicating if JBake properties should be made available to Asciidoctor

ASCIIDOCTOR_ATTRIBUTES_EXPORT_PREFIX - Static variable in interface org.jbake.app.ConfigUtil.Keys

Prefix to be used when exporting JBake properties to Asciidoctor

ASCIIDOCTOR_OPTION - Static variable in interface org.jbake.app.ConfigUtil.Keys

Asciidoctor options to be set when processing input

AsciidoctorEngine - Class in org.jbake.parser

Renders documents in the asciidoc format using the Asciidoctor engine.

AsciidoctorEngine() - Constructor for class org.jbake.parser.AsciidoctorEngine

asPath(File) - Static method in class org.jbake.app.FileUtil

platform independent file.getPath()

asPath(String) - Static method in class org.jbake.app.FileUtil

platform independent file.getPath()

Asset - Class in org.jbake.app

Deals with assets (static files such as css, js or image files).

Asset(File, File, CompositeConfiguration) - Constructor for class org.jbake.app.Asset

Creates an instance of Asset.

ASSET_FOLDER - Static variable in interface org.jbake.app.ConfigUtil.Keys

Folder where assets are stored, they are copied directly in output folder and not processed

ASSET_IGNORE_HIDDEN - Static variable in interface org.jbake.app.ConfigUtil.Keys

Flag indicating if hidden asset resources should be ignored

B

bake() - Method in class org.jbake.app.Oven

All the good stuff happens in here...

BUILD_TIMESTAMP - Static variable in interface org.jbake.app.ConfigUtil.Keys

Timestamp that records when JBake build was made

C

close() - Method in class org.jbake.app.ContentStore

config - Variable in class org.jbake.template.AbstractTemplateEngine

ConfigUtil - Class in org.jbake.app

Provides Configuration related functions.

ConfigUtil() - Constructor for class org.jbake.app.ConfigUtil

ConfigUtil.Keys - Interface in org.jbake.app

Set of config keys used by JBake

CONTENT_FOLDER - Static variable in interface org.jbake.app.ConfigUtil.Keys

Folder where content (that's to say files to be transformed) resides in

ContentStore - Class in org.jbake.app

ContentStore(String, String) - Constructor for class org.jbake.app.ContentStore

copy(File) - Method in class org.jbake.app.Asset

Copy all files from supplied path.

countClass(String) - Method in class org.jbake.app.ContentStore

crawl(File) - Method in class org.jbake.app.Crawler

Crawl all files and folders looking for content.

Crawler - Class in org.jbake.app

Crawls a file system looking for content.

Crawler(ContentStore, File, CompositeConfiguration) - Constructor for class org.jbake.app.Crawler

Creates new instance of Crawler.

createDataStore(String, String) - Static method in class org.jbake.app.DBUtil

createDB(String, String) - Static method in class org.jbake.app.DBUtil

D

DATE_FORMAT - Static variable in interface org.jbake.app.ConfigUtil.Keys

How date is formated

db - Variable in class org.jbake.template.AbstractTemplateEngine

DB_PATH - Static variable in interface org.jbake.app.ConfigUtil.Keys

Folder to store database files in

DB_STORE - Static variable in interface org.jbake.app.ConfigUtil.Keys

Flag to identify if database is kept in memory (memory) or persisted to disk (local)

DBUtil - Class in org.jbake.app

DBUtil() - Constructor for class org.jbake.app.DBUtil

DEFAULT_STATUS - Static variable in interface org.jbake.app.ConfigUtil.Keys

Default status to use (in order to avoid putting it in all files)

DelegatingTemplateEngine - Class in org.jbake.template

A template which is responsible for delegating to a supported template engine, based on the file extension.

DelegatingTemplateEngine(CompositeConfiguration, ContentStore, File, File) - Constructor for class org.jbake.template.DelegatingTemplateEngine

deleteAllByDocType(String) - Method in class org.jbake.app.ContentStore

deleteContent(String, String) - Method in class org.jbake.app.ContentStore

destination - Variable in class org.jbake.template.AbstractTemplateEngine

DESTINATION_FOLDER - Static variable in interface org.jbake.app.ConfigUtil.Keys

Folder where rendered files are output

DocumentIterator - Class in org.jbake.app

DocumentIterator(Iterator<ODocument>) - Constructor for class org.jbake.app.DocumentIterator

DocumentList - Class in org.jbake.app

Wraps an OrientDB document iterator into a model usable by template engines.

DocumentList() - Constructor for class org.jbake.app.DocumentList

DocumentStatus - Enum in org.jbake.model

Enumeration used to determine whether rendering of a document should be done.

documentToModel(ODocument) - Static method in class org.jbake.app.DBUtil

DocumentTypes - Class in org.jbake.model

Utility class used to determine the list of document types.

DocumentTypes() - Constructor for class org.jbake.model.DocumentTypes

DRAFT_SUFFIX - Static variable in interface org.jbake.app.ConfigUtil.Keys

Suffix used to identify draft files

drop() - Method in class org.jbake.app.ContentStore

E

Engines - Class in org.jbake.parser

A singleton class giving access to markup engines.

ErrorEngine - Class in org.jbake.parser

An internal rendering engine used to notify the user that the markup format he used requires an engine that couldn't be loaded.

ErrorEngine() - Constructor for class org.jbake.parser.ErrorEngine

ErrorEngine(String) - Constructor for class org.jbake.parser.ErrorEngine

extract(InputStream, File) - Static method in class org.jbake.app.ZipUtil

Extracts content of Zip file to specified output path.

F

FEED_FILE - Static variable in interface org.jbake.app.ConfigUtil.Keys

Output filename for feed file, is only used when ConfigUtil.Keys.RENDER_FEED is true

fileExt(File) - Static method in class org.jbake.app.FileUtil

fileExt(String) - Static method in class org.jbake.app.FileUtil

FileUtil - Class in org.jbake.app

Provides File related functions

FileUtil() - Constructor for class org.jbake.app.FileUtil

findExtension(CompositeConfiguration, String) - Static method in class org.jbake.app.FileUtil

FreemarkerTemplateEngine - Class in org.jbake.template

Renders pages using the Freemarker template engine.

FreemarkerTemplateEngine(CompositeConfiguration, ContentStore, File, File) - Constructor for class org.jbake.template.FreemarkerTemplateEngine

FreemarkerTemplateEngine.LazyLoadingModel - Class in org.jbake.template

A custom Freemarker model that avoids loading the whole documents into memory if not necessary.

FreemarkerTemplateEngine.LazyLoadingModel(Map<String, Object>, ContentStore) - Constructor for class org.jbake.template.FreemarkerTemplateEngine.LazyLoadingModel

G

get(String) - Static method in class org.jbake.parser.Engines

get(String) - Method in class org.jbake.template.FreemarkerTemplateEngine.LazyLoadingModel

getAllContent(String) - Method in class org.jbake.app.ContentStore

getAllTagsFromPublishedPosts() - Method in class org.jbake.app.ContentStore

getBody() - Method in class org.jbake.parser.ParserContext

getComparator() - Static method in class org.jbake.app.SortUtil

getComparator(int) - Static method in class org.jbake.app.SortUtil

getConfig() - Method in class org.jbake.app.Oven

getConfig() - Method in class org.jbake.parser.ParserContext

getContentPath() - Method in class org.jbake.parser.ParserContext

getContents() - Method in class org.jbake.parser.ParserContext

getDestination() - Method in class org.jbake.launcher.LaunchOptions

getDestinationValue() - Method in class org.jbake.launcher.LaunchOptions

getDocumentCount(String) - Method in class org.jbake.app.Crawler

getDocumentStatus(String, String) - Method in class org.jbake.app.ContentStore

getDocumentTypes() - Static method in class org.jbake.model.DocumentTypes

getEngine(String) - Method in class org.jbake.template.TemplateEngines

getErrors() - Method in class org.jbake.app.Asset

getErrors() - Method in class org.jbake.app.Oven

getFile() - Method in class org.jbake.parser.ParserContext

getFileFilter() - Static method in class org.jbake.app.FileUtil

Filters files based on their file extension.

getFileLines() - Method in class org.jbake.parser.ParserContext

getPathToRoot(File) - Method in class org.jbake.app.Crawler

getPublishedContent(String) - Method in class org.jbake.app.ContentStore

getPublishedPages() - Method in class org.jbake.app.ContentStore

getPublishedPosts() - Method in class org.jbake.app.ContentStore

getPublishedPostsByTag(String) - Method in class org.jbake.app.ContentStore

getRecognizedExtensions() - Static method in class org.jbake.parser.Engines

getRecognizedExtensions() - Method in class org.jbake.template.TemplateEngines

getRunningLocation() - Static method in class org.jbake.app.FileUtil

Works out the folder where JBake is running from.

getSignaturesForTemplates() - Method in class org.jbake.app.ContentStore

getSource() - Method in class org.jbake.launcher.LaunchOptions

getSourceValue() - Method in class org.jbake.launcher.LaunchOptions

getTags() - Method in class org.jbake.app.Crawler

getTemplate() - Method in class org.jbake.launcher.LaunchOptions

getUnrenderedContent(String) - Method in class org.jbake.app.ContentStore

GroovyTemplateEngine - Class in org.jbake.template

Renders documents using a Groovy template engine.

GroovyTemplateEngine(CompositeConfiguration, ContentStore, File, File) - Constructor for class org.jbake.template.GroovyTemplateEngine

H

hasHeader() - Method in class org.jbake.parser.ParserContext

hasNext() - Method in class org.jbake.app.DocumentIterator

I

INDEX_FILE - Static variable in interface org.jbake.app.ConfigUtil.Keys

Output filename for index, is only used when ConfigUtil.Keys.RENDER_INDEX is true

Init - Class in org.jbake.launcher

Initialises sample folder structure with pre-defined template

Init(CompositeConfiguration) - Constructor for class org.jbake.launcher.Init

insertSignature(String) - Method in class org.jbake.app.ContentStore

isBake() - Method in class org.jbake.launcher.LaunchOptions

isClearCache() - Method in class org.jbake.launcher.LaunchOptions

isEmpty() - Method in class org.jbake.template.FreemarkerTemplateEngine.LazyLoadingModel

isExistingFolder(File) - Static method in class org.jbake.app.FileUtil

isHelpNeeded() - Method in class org.jbake.launcher.LaunchOptions

isInit() - Method in class org.jbake.launcher.LaunchOptions

isRunServer() - Method in class org.jbake.launcher.LaunchOptions

J

JBakeException - Exception in org.jbake.app

This runtime exception is thrown by JBake API to indicate an processing error.

JBakeException(String, Throwable) - Constructor for exception org.jbake.app.JBakeException

JBakeException(String) - Constructor for exception org.jbake.app.JBakeException

JettyServer - Class in org.jbake.launcher

Provides Jetty server related functions

JettyServer() - Constructor for class org.jbake.launcher.JettyServer

L

LaunchOptions - Class in org.jbake.launcher

LaunchOptions() - Constructor for class org.jbake.launcher.LaunchOptions

load(File) - Static method in class org.jbake.app.ConfigUtil

M

Main - Class in org.jbake.launcher

Launcher for JBake.

Main() - Constructor for class org.jbake.launcher.Main

main(String[]) - Static method in class org.jbake.launcher.Main

Runs the app with the given arguments.

markConentAsRendered(String) - Method in class org.jbake.app.ContentStore

MarkdownEngine - Class in org.jbake.parser

Renders documents in the Markdown format.

MarkdownEngine() - Constructor for class org.jbake.parser.MarkdownEngine

MarkupEngine - Class in org.jbake.parser

Base class for markup engine wrappers.

MarkupEngine() - Constructor for class org.jbake.parser.MarkupEngine

N

next() - Method in class org.jbake.app.DocumentIterator

NORMAL - Static variable in class org.jbake.app.SortUtil

O

org.jbake.app - package org.jbake.app

org.jbake.launcher - package org.jbake.launcher

org.jbake.model - package org.jbake.model

org.jbake.parser - package org.jbake.parser

org.jbake.template - package org.jbake.template

OUTPUT_EXTENSION - Static variable in interface org.jbake.app.ConfigUtil.Keys

File extension to be used for all output files

Oven - Class in org.jbake.app

All the baking happens in the Oven!

Oven(File, File, boolean) - Constructor for class org.jbake.app.Oven

Delegate c'tor to prevent API break for the moment.

Oven(File, File, CompositeConfiguration, boolean) - Constructor for class org.jbake.app.Oven

Creates a new instance of the Oven with references to the source and destination folders.

P

Parser - Class in org.jbake.app

Parses a File for content.

Parser(CompositeConfiguration, String) - Constructor for class org.jbake.app.Parser

Creates a new instance of Parser.

ParserContext - Class in org.jbake.parser

ParserContext(File, List<String>, CompositeConfiguration, String, boolean, Map<String, Object>) - Constructor for class org.jbake.parser.ParserContext

processBody(ParserContext) - Method in class org.jbake.parser.AsciidoctorEngine

processBody(ParserContext) - Method in class org.jbake.parser.ErrorEngine

processBody(ParserContext) - Method in class org.jbake.parser.MarkdownEngine

processBody(ParserContext) - Method in class org.jbake.parser.MarkupEngine

Processes the body of the document.

processFile(File) - Method in class org.jbake.app.Parser

Process the file by parsing the contents.

processHeader(ParserContext) - Method in class org.jbake.parser.AsciidoctorEngine

processHeader(ParserContext) - Method in class org.jbake.parser.ErrorEngine

processHeader(ParserContext) - Method in class org.jbake.parser.MarkupEngine

Processes the document header.

R

RawMarkupEngine - Class in org.jbake.parser

RawMarkupEngine() - Constructor for class org.jbake.parser.RawMarkupEngine

register(String, MarkupEngine) - Static method in class org.jbake.parser.Engines

remove() - Method in class org.jbake.app.DocumentIterator

render(Map<String, Object>) - Method in class org.jbake.app.Renderer

Render the supplied content to a file.

RENDER_ARCHIVE - Static variable in interface org.jbake.app.ConfigUtil.Keys

Flag indicating if archive file should be generated

RENDER_ENCODING - Static variable in interface org.jbake.app.ConfigUtil.Keys

Encoding used when rendering files

RENDER_FEED - Static variable in interface org.jbake.app.ConfigUtil.Keys

Flag indicating if feed file should be generated

RENDER_INDEX - Static variable in interface org.jbake.app.ConfigUtil.Keys

Flag indicating if index file should be generated

RENDER_SITEMAP - Static variable in interface org.jbake.app.ConfigUtil.Keys

Flag indicating if sitemap file should be generated

RENDER_TAGS - Static variable in interface org.jbake.app.ConfigUtil.Keys

Flag indicating if tag files should be generated

renderArchive(String) - Method in class org.jbake.app.Renderer

Render an archive file using the supplied content.

renderDocument(Map<String, Object>, String, Writer) - Method in class org.jbake.template.AbstractTemplateEngine

renderDocument(Map<String, Object>, String, Writer) - Method in class org.jbake.template.DelegatingTemplateEngine

renderDocument(Map<String, Object>, String, Writer) - Method in class org.jbake.template.FreemarkerTemplateEngine

renderDocument(Map<String, Object>, String, Writer) - Method in class org.jbake.template.GroovyTemplateEngine

renderDocument(Map<String, Object>, String, Writer) - Method in class org.jbake.template.ThymeleafTemplateEngine

Renderer - Class in org.jbake.app

Render output to a file.

Renderer(ContentStore, File, File, CompositeConfiguration) - Constructor for class org.jbake.app.Renderer

Creates a new instance of Renderer with supplied references to folders.

renderFeed(String) - Method in class org.jbake.app.Renderer

Render an XML feed file using the supplied content.

renderIndex(String) - Method in class org.jbake.app.Renderer

Render an index file using the supplied content.

RenderingException - Exception in org.jbake.template

Thrown if rendering of a document failed.

RenderingException(Throwable) - Constructor for exception org.jbake.template.RenderingException

RenderingException(String, Throwable) - Constructor for exception org.jbake.template.RenderingException

RenderingException(String) - Constructor for exception org.jbake.template.RenderingException

renderSitemap(String) - Method in class org.jbake.app.Renderer

Render an XML sitemap file using the supplied content.

renderTags(Set<String>, String) - Method in class org.jbake.app.Renderer

Render tag files using the supplied content.

REVERSE - Static variable in class org.jbake.app.SortUtil

run(File, File, String) - Method in class org.jbake.launcher.Init

Performs checks on output folder before extracting template file

run(String, String) - Static method in class org.jbake.launcher.JettyServer

Run Jetty web server serving out supplied path on supplied port

S

SERVER_PORT - Static variable in interface org.jbake.app.ConfigUtil.Keys

Port used when running Jetty server

setBody(String) - Method in class org.jbake.parser.ParserContext

setConfig(CompositeConfiguration) - Method in class org.jbake.app.Oven

setupPaths() - Method in class org.jbake.app.Oven

Checks source path contains required sub-folders (i.e.

sha1(File) - Static method in class org.jbake.app.FileUtil

Computes the hash of a file or directory.

SITEMAP_FILE - Static variable in interface org.jbake.app.ConfigUtil.Keys

Sitemap template file name.

SortUtil - Class in org.jbake.app

Provides Sort related functions

SortUtil() - Constructor for class org.jbake.app.SortUtil

T

TAG_PATH - Static variable in interface org.jbake.app.ConfigUtil.Keys

Tags output path, used only when ConfigUtil.Keys.RENDER_TAGS is true

TAG_SANITIZE - Static variable in interface org.jbake.app.ConfigUtil.Keys

Should the tag value be sanitized?

TEMPLATE_ENCODING - Static variable in interface org.jbake.app.ConfigUtil.Keys

Encoding to be used for template files

TEMPLATE_FOLDER - Static variable in interface org.jbake.app.ConfigUtil.Keys

Folder where template files are looked for

TemplateEngines - Class in org.jbake.template

A singleton class giving access to rendering engines.

TemplateEngines(CompositeConfiguration, ContentStore, File, File) - Constructor for class org.jbake.template.TemplateEngines

templatesPath - Variable in class org.jbake.template.AbstractTemplateEngine

THYMELEAF_LOCALE - Static variable in interface org.jbake.app.ConfigUtil.Keys

Locale used for Thymeleaf template rendering

ThymeleafTemplateEngine - Class in org.jbake.template

A template engine which renders pages using Thymeleaf.

ThymeleafTemplateEngine(CompositeConfiguration, ContentStore, File, File) - Constructor for class org.jbake.template.ThymeleafTemplateEngine

toStringArray(Object) - Static method in class org.jbake.app.DBUtil

Converts a DB list into a String array

U

updateSchema() - Method in class org.jbake.app.ContentStore

updateSchema(ContentStore) - Static method in class org.jbake.app.DBUtil

updateSignatures(String) - Method in class org.jbake.app.ContentStore

V

validate(ParserContext) - Method in class org.jbake.parser.MarkupEngine

Tests if this markup engine can process the document.

valueOf(String) - Static method in enum org.jbake.model.DocumentStatus

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.jbake.model.DocumentStatus

Returns an array containing the constants of this enum type, in the order they are declared.

VERSION - Static variable in interface org.jbake.app.ConfigUtil.Keys

Version of JBake

W

wrap(Iterator<ODocument>) - Static method in class org.jbake.app.DocumentList

Z

ZipUtil - Class in org.jbake.app

Provides Zip file related functions

ZipUtil() - Constructor for class org.jbake.app.ZipUtil

A B C D E F G H I J L M N O P R S T U V W Z