public class DefaultJBakeConfiguration extends java.lang.Object implements JBakeConfiguration
JBakeConfiguration| Constructor and Description |
|---|
DefaultJBakeConfiguration(org.apache.commons.configuration.CompositeConfiguration configuration)
Deprecated.
|
DefaultJBakeConfiguration(java.io.File sourceFolder,
org.apache.commons.configuration.CompositeConfiguration configuration) |
| Modifier and Type | Method and Description |
|---|---|
java.lang.Object |
get(java.lang.String key)
Get property value by a given key from the configuration
|
java.lang.String |
getArchiveFileName() |
java.util.List<java.lang.String> |
getAsciidoctorAttributes() |
java.lang.Object |
getAsciidoctorOption(java.lang.String optionKey)
Get an asciidoctor option by it's key
|
java.util.List<java.lang.String> |
getAsciidoctorOptionKeys()
Get a list of asciidoctor options
|
java.io.File |
getAssetFolder() |
java.lang.String |
getAssetFolderName() |
boolean |
getAssetIgnoreHidden() |
java.lang.String |
getAttributesExportPrefixForAsciidoctor() |
java.lang.String |
getBuildTimeStamp() |
boolean |
getClearCache() |
org.apache.commons.configuration.CompositeConfiguration |
getCompositeConfiguration() |
java.io.File |
getContentFolder() |
java.lang.String |
getContentFolderName() |
java.lang.String |
getDatabasePath() |
java.lang.String |
getDatabaseStore() |
java.lang.String |
getDateFormat() |
java.lang.String |
getDefaultStatus() |
java.lang.String |
getDefaultType() |
java.io.File |
getDestinationFolder() |
java.util.List<java.lang.String> |
getDocumentTypes() |
java.lang.String |
getDraftSuffix() |
java.lang.String |
getExampleProjectByType(java.lang.String templateType)
Get name for example project name by given template type
|
boolean |
getExportAsciidoctorAttributes() |
java.lang.String |
getFeedFileName() |
java.lang.String |
getHeaderSeparator() |
boolean |
getImgPathPrependHost() |
boolean |
getImgPathUpdate() |
java.lang.String |
getIndexFileName() |
java.util.Iterator<java.lang.String> |
getKeys()
Get an iterator of available configuration keys
|
java.util.List<java.lang.String> |
getMarkdownExtensions()
A list of markdown extensions
|
java.lang.String |
getOutputExtension() |
java.lang.String |
getOutputExtensionByDocType(java.lang.String docType) |
boolean |
getPaginateIndex() |
int |
getPostsPerPage() |
java.lang.String |
getPrefixForUriWithoutExtension() |
boolean |
getRenderArchive() |
java.lang.String |
getRenderEncoding() |
boolean |
getRenderFeed() |
boolean |
getRenderIndex() |
boolean |
getRenderSiteMap() |
boolean |
getRenderTags() |
boolean |
getRenderTagsIndex() |
boolean |
getSanitizeTag() |
int |
getServerPort() |
java.lang.String |
getSiteHost() |
java.lang.String |
getSiteMapFileName() |
java.io.File |
getSourceFolder() |
java.lang.String |
getTagPathName() |
java.lang.String |
getTemplateEncoding() |
java.io.File |
getTemplateFileByDocType(java.lang.String docType) |
java.io.File |
getTemplateFolder() |
java.lang.String |
getTemplateFolderName() |
java.lang.String |
getThymeleafLocale() |
boolean |
getUriWithoutExtension() |
java.lang.String |
getVersion() |
void |
setAssetFolder(java.io.File assetFolder) |
void |
setAssetIgnoreHidden(boolean assetIgnoreHidden) |
void |
setClearCache(boolean clearCache) |
void |
setCompositeConfiguration(org.apache.commons.configuration.CompositeConfiguration configuration) |
void |
setContentFolder(java.io.File contentFolder) |
void |
setDatabasePath(java.lang.String path) |
void |
setDatabaseStore(java.lang.String storeType) |
void |
setDefaultStatus(java.lang.String status) |
void |
setDefaultType(java.lang.String type) |
void |
setDestinationFolder(java.io.File destinationFolder) |
void |
setDestinationFolderName(java.lang.String folderName) |
void |
setExampleProject(java.lang.String type,
java.lang.String fileName) |
void |
setHeaderSeparator(java.lang.String headerSeparator) |
void |
setImgPathPrependHost(boolean imgPathPrependHost) |
void |
setImgPathUPdate(boolean imgPathUpdate) |
void |
setMarkdownExtensions(java.lang.String... extensions) |
void |
setOutputExtension(java.lang.String outputExtension) |
void |
setPaginateIndex(boolean paginateIndex) |
void |
setPostsPerPage(int postsPerPage) |
void |
setPrefixForUriWithoutExtension(java.lang.String prefix) |
void |
setProperty(java.lang.String key,
java.lang.Object value)
Set a property value for the given key
|
void |
setRenderTagsIndex(boolean enable) |
void |
setServerPort(int port) |
void |
setSiteHost(java.lang.String siteHost) |
void |
setSourceFolder(java.io.File sourceFolder) |
void |
setTemplateExtensionForDocType(java.lang.String docType,
java.lang.String extension) |
void |
setTemplateFileNameForDocType(java.lang.String docType,
java.lang.String fileName) |
void |
setTemplateFolder(java.io.File templateFolder) |
void |
setUriWithoutExtension(boolean withoutExtension) |
@Deprecated public DefaultJBakeConfiguration(org.apache.commons.configuration.CompositeConfiguration configuration)
DefaultJBakeConfiguration(File, CompositeConfiguration) insteadconfiguration - The project configurationpublic DefaultJBakeConfiguration(java.io.File sourceFolder,
org.apache.commons.configuration.CompositeConfiguration configuration)
public java.lang.Object get(java.lang.String key)
JBakeConfigurationget in interface JBakeConfigurationkey - a key for the property like site.hostpublic java.lang.String getArchiveFileName()
getArchiveFileName in interface JBakeConfigurationJBakeConfiguration.getRenderArchive() is truepublic java.util.List<java.lang.String> getAsciidoctorAttributes()
getAsciidoctorAttributes in interface JBakeConfigurationpublic java.lang.Object getAsciidoctorOption(java.lang.String optionKey)
JBakeConfigurationgetAsciidoctorOption in interface JBakeConfigurationoptionKey - an option keypublic java.util.List<java.lang.String> getAsciidoctorOptionKeys()
JBakeConfigurationgetAsciidoctorOptionKeys in interface JBakeConfigurationpublic java.io.File getAssetFolder()
getAssetFolder in interface JBakeConfigurationpublic void setAssetFolder(java.io.File assetFolder)
public java.lang.String getAssetFolderName()
getAssetFolderName in interface JBakeConfigurationpublic boolean getAssetIgnoreHidden()
getAssetIgnoreHidden in interface JBakeConfigurationpublic void setAssetIgnoreHidden(boolean assetIgnoreHidden)
public java.lang.String getAttributesExportPrefixForAsciidoctor()
getAttributesExportPrefixForAsciidoctor in interface JBakeConfigurationpublic java.lang.String getBuildTimeStamp()
getBuildTimeStamp in interface JBakeConfigurationpublic boolean getClearCache()
getClearCache in interface JBakeConfigurationpublic void setClearCache(boolean clearCache)
public org.apache.commons.configuration.CompositeConfiguration getCompositeConfiguration()
public void setCompositeConfiguration(org.apache.commons.configuration.CompositeConfiguration configuration)
public java.io.File getContentFolder()
getContentFolder in interface JBakeConfigurationpublic void setContentFolder(java.io.File contentFolder)
public java.lang.String getContentFolderName()
getContentFolderName in interface JBakeConfigurationpublic java.lang.String getDatabasePath()
getDatabasePath in interface JBakeConfigurationpublic void setDatabasePath(java.lang.String path)
public java.lang.String getDatabaseStore()
getDatabaseStore in interface JBakeConfigurationpublic void setDatabaseStore(java.lang.String storeType)
public java.lang.String getDateFormat()
getDateFormat in interface JBakeConfigurationpublic java.lang.String getDefaultStatus()
getDefaultStatus in interface JBakeConfigurationpublic void setDefaultStatus(java.lang.String status)
public java.lang.String getDefaultType()
getDefaultType in interface JBakeConfigurationpublic void setDefaultType(java.lang.String type)
public java.io.File getDestinationFolder()
getDestinationFolder in interface JBakeConfigurationpublic void setDestinationFolder(java.io.File destinationFolder)
setDestinationFolder in interface JBakeConfigurationpublic java.util.List<java.lang.String> getDocumentTypes()
getDocumentTypes in interface JBakeConfigurationpublic java.lang.String getDraftSuffix()
getDraftSuffix in interface JBakeConfigurationpublic java.lang.String getExampleProjectByType(java.lang.String templateType)
JBakeConfigurationgetExampleProjectByType in interface JBakeConfigurationtemplateType - a template typepublic boolean getExportAsciidoctorAttributes()
getExportAsciidoctorAttributes in interface JBakeConfigurationpublic java.lang.String getFeedFileName()
getFeedFileName in interface JBakeConfigurationJBakeConfiguration.getRenderFeed() der} is truepublic java.lang.String getIndexFileName()
getIndexFileName in interface JBakeConfigurationJBakeConfiguration.getRenderIndex() is truepublic java.util.Iterator<java.lang.String> getKeys()
JBakeConfigurationgetKeys in interface JBakeConfigurationpublic java.util.List<java.lang.String> getMarkdownExtensions()
JBakeConfiguration
markdown.extension=HARDWRAPS,AUTOLINKS,FENCED_CODE_BLOCKS,DEFINITIONS
getMarkdownExtensions in interface JBakeConfigurationpublic void setMarkdownExtensions(java.lang.String... extensions)
public java.lang.String getOutputExtension()
getOutputExtension in interface JBakeConfigurationpublic void setOutputExtension(java.lang.String outputExtension)
public java.lang.String getOutputExtensionByDocType(java.lang.String docType)
getOutputExtensionByDocType in interface JBakeConfigurationpublic boolean getPaginateIndex()
getPaginateIndex in interface JBakeConfigurationpublic void setPaginateIndex(boolean paginateIndex)
public int getPostsPerPage()
getPostsPerPage in interface JBakeConfigurationpublic void setPostsPerPage(int postsPerPage)
public java.lang.String getPrefixForUriWithoutExtension()
getPrefixForUriWithoutExtension in interface JBakeConfigurationpublic void setPrefixForUriWithoutExtension(java.lang.String prefix)
public boolean getRenderArchive()
getRenderArchive in interface JBakeConfigurationpublic java.lang.String getRenderEncoding()
getRenderEncoding in interface JBakeConfigurationpublic boolean getRenderFeed()
getRenderFeed in interface JBakeConfigurationpublic boolean getRenderIndex()
getRenderIndex in interface JBakeConfigurationpublic boolean getRenderSiteMap()
getRenderSiteMap in interface JBakeConfigurationpublic boolean getRenderTags()
getRenderTags in interface JBakeConfigurationpublic boolean getRenderTagsIndex()
getRenderTagsIndex in interface JBakeConfigurationpublic void setRenderTagsIndex(boolean enable)
public boolean getSanitizeTag()
getSanitizeTag in interface JBakeConfigurationpublic int getServerPort()
getServerPort in interface JBakeConfigurationpublic void setServerPort(int port)
public java.lang.String getSiteHost()
getSiteHost in interface JBakeConfigurationpublic void setSiteHost(java.lang.String siteHost)
public java.lang.String getSiteMapFileName()
getSiteMapFileName in interface JBakeConfigurationJBakeConfiguration.getRenderSiteMap() is set to truepublic java.io.File getSourceFolder()
getSourceFolder in interface JBakeConfigurationpublic void setSourceFolder(java.io.File sourceFolder)
public java.lang.String getTagPathName()
getTagPathName in interface JBakeConfigurationJBakeConfiguration.getRenderTags() is truepublic java.lang.String getTemplateEncoding()
getTemplateEncoding in interface JBakeConfigurationpublic java.io.File getTemplateFileByDocType(java.lang.String docType)
getTemplateFileByDocType in interface JBakeConfigurationpublic java.io.File getTemplateFolder()
getTemplateFolder in interface JBakeConfigurationpublic void setTemplateFolder(java.io.File templateFolder)
public java.lang.String getTemplateFolderName()
getTemplateFolderName in interface JBakeConfigurationpublic java.lang.String getThymeleafLocale()
getThymeleafLocale in interface JBakeConfigurationpublic boolean getUriWithoutExtension()
getUriWithoutExtension in interface JBakeConfigurationpublic void setUriWithoutExtension(boolean withoutExtension)
public java.lang.String getVersion()
getVersion in interface JBakeConfigurationpublic void setDestinationFolderName(java.lang.String folderName)
public void setExampleProject(java.lang.String type,
java.lang.String fileName)
public void setProperty(java.lang.String key,
java.lang.Object value)
JBakeConfigurationsetProperty in interface JBakeConfigurationkey - the key for the propertyvalue - the value of the propertypublic void setTemplateExtensionForDocType(java.lang.String docType,
java.lang.String extension)
public void setTemplateFileNameForDocType(java.lang.String docType,
java.lang.String fileName)
public java.lang.String getHeaderSeparator()
getHeaderSeparator in interface JBakeConfigurationpublic void setHeaderSeparator(java.lang.String headerSeparator)
public boolean getImgPathPrependHost()
getImgPathPrependHost in interface JBakeConfigurationJBakeConfiguration.getSiteHost() value - only has an effect if
JBakeConfiguration.getImgPathUpdate() is set to truepublic void setImgPathPrependHost(boolean imgPathPrependHost)
public boolean getImgPathUpdate()
getImgPathUpdate in interface JBakeConfigurationJBakeConfiguration.getImgPathUpdate() which allows you to control the absolute path usedpublic void setImgPathUPdate(boolean imgPathUpdate)