Package io.siddhi.doc.gen.core.utils

Class Constants

java.lang.Object

io.siddhi.doc.gen.core.utils.Constants

public class Constants
extends Object

Constants used by the doc generator and the free marker templates

These constants will be passed onto the freemarker templates as a map These can be accesses using the CONSTANTS variable eg:- CONSTANTS.DOCS_DIRECTORY

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_SUB_DIRECTORY
static String	CLASS_FILE_EXTENSION
static String	CLASSES_DIRECTORY
static String	CORE_NAMESPACE
static Charset	DEFAULT_CHARSET
static String	DOCS_DIRECTORY
static String	FREEMARKER_EXTENSION_REPOSITORY_PARENT_POSTFIX
static String	FREEMARKER_FEATURES_HEADING
static String	FREEMARKER_LATEST_API_DOCS_HEADING
static String	FREEMARKER_SIDDHI_HOME_PAGE
static String	FREEMARKER_SIDDHI_REPOSITORY_ARTIFACT_ID
static String	FREEMARKER_TEMPLATE_FILE_EXTENSION
static String	GIT_ADD_COMMAND
static String	GIT_BRANCH_COMMAND
static String	GIT_BRANCH_COMMAND_OUTPUT_CURRENT_BRANCH_PREFIX
static String	GIT_CHECKOUT_COMMAND
static String	GIT_CHECKOUT_COMMAND_ORPHAN_ARGUMENT
static String	GIT_COMMAND
static String	GIT_COMMIT_COMMAND
static String	GIT_COMMIT_COMMAND_FILES_ARGUMENT
static String	GIT_COMMIT_COMMAND_MESSAGE_ARGUMENT
static String	GIT_COMMIT_COMMAND_MESSAGE_FORMAT
static String	GIT_GH_PAGES_BRANCH
static String	GIT_MASTER_BRANCH
static String	GIT_PULL_COMMAND
static String	GIT_PUSH_COMMAND
static String	GIT_REMOTE
static String	GIT_STASH_COMMAND
static String	GIT_STASH_POP_COMMAND
static String	GITHUB_APACHE_EXTENSION_REPOSITORY_PREFIX
static String	GITHUB_GPL_EXTENSION_REPOSITORY_PREFIX
static String	GITHUB_OWNER_WSO2_EXTENSIONS
static String	GITHUB_URL
static String	GITHUB_URL_WITH_USERNAME_PASSWORD
static String	HOMEPAGE_FILE_NAME
static String	LATEST_FILE_NAME
static String	MARKDOWN_DOCUMENTATION_TEMPLATE
static String	MARKDOWN_EXTENSIONS_INDEX_TEMPLATE
static String	MARKDOWN_FILE_EXTENSION
static String	MARKDOWN_HEADINGS_UPDATE_TEMPLATE
static String	MKDOCS_BUILD_COMMAND
static String	MKDOCS_BUILD_COMMAND_CLEAN_ARGUEMENT
static String	MKDOCS_BUILD_COMMAND_CONFIG_FILE_ARGUMENT
static String	MKDOCS_BUILD_COMMAND_SITE_DIRECTORY_ARGUMENT
static String	MKDOCS_COMMAND
static String	MKDOCS_CONFIG_FILE_NAME
static String	MKDOCS_CONFIG_PAGES_API_KEY
static String	MKDOCS_CONFIG_PAGES_KEY
static String	MKDOCS_FILE_SEPARATOR
static String	MKDOCS_SITE_DIRECTORY
static String	README_FILE_NAME
static String	SNAPSHOT_VERSION_POSTFIX
static String	SYSTEM_PROPERTY_SCM_PASSWORD_KEY
static String	SYSTEM_PROPERTY_SCM_USERNAME_KEY
static String	TEMPLATES_DIRECTORY
static String	YAML_FILE_EXTENSION

Constructor Summary

Constructors

Constructor	Description
Constants()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

DOCS_DIRECTORY

public static final String DOCS_DIRECTORY

See Also:

Constant Field Values

CLASSES_DIRECTORY

public static final String CLASSES_DIRECTORY

See Also:

Constant Field Values

TEMPLATES_DIRECTORY

public static final String TEMPLATES_DIRECTORY

See Also:

Constant Field Values

API_SUB_DIRECTORY

public static final String API_SUB_DIRECTORY

See Also:

Constant Field Values

README_FILE_NAME

public static final String README_FILE_NAME

See Also:

Constant Field Values

LATEST_FILE_NAME

public static final String LATEST_FILE_NAME

See Also:

Constant Field Values

MKDOCS_CONFIG_FILE_NAME

public static final String MKDOCS_CONFIG_FILE_NAME

See Also:

Constant Field Values

HOMEPAGE_FILE_NAME

public static final String HOMEPAGE_FILE_NAME

See Also:

Constant Field Values

FREEMARKER_TEMPLATE_FILE_EXTENSION

public static final String FREEMARKER_TEMPLATE_FILE_EXTENSION

See Also:

Constant Field Values

CLASS_FILE_EXTENSION

public static final String CLASS_FILE_EXTENSION

See Also:

Constant Field Values

MARKDOWN_FILE_EXTENSION

public static final String MARKDOWN_FILE_EXTENSION

See Also:

Constant Field Values

YAML_FILE_EXTENSION

public static final String YAML_FILE_EXTENSION

See Also:

Constant Field Values

MARKDOWN_DOCUMENTATION_TEMPLATE

public static final String MARKDOWN_DOCUMENTATION_TEMPLATE

See Also:

Constant Field Values

MARKDOWN_EXTENSIONS_INDEX_TEMPLATE

public static final String MARKDOWN_EXTENSIONS_INDEX_TEMPLATE

See Also:

Constant Field Values

MARKDOWN_HEADINGS_UPDATE_TEMPLATE

public static final String MARKDOWN_HEADINGS_UPDATE_TEMPLATE

See Also:

Constant Field Values

GITHUB_GPL_EXTENSION_REPOSITORY_PREFIX

public static final String GITHUB_GPL_EXTENSION_REPOSITORY_PREFIX

See Also:

Constant Field Values

GITHUB_APACHE_EXTENSION_REPOSITORY_PREFIX

public static final String GITHUB_APACHE_EXTENSION_REPOSITORY_PREFIX

See Also:

Constant Field Values

GITHUB_OWNER_WSO2_EXTENSIONS

public static final String GITHUB_OWNER_WSO2_EXTENSIONS

See Also:

Constant Field Values

SYSTEM_PROPERTY_SCM_USERNAME_KEY

public static final String SYSTEM_PROPERTY_SCM_USERNAME_KEY

See Also:

Constant Field Values

SYSTEM_PROPERTY_SCM_PASSWORD_KEY

public static final String SYSTEM_PROPERTY_SCM_PASSWORD_KEY

See Also:

Constant Field Values

MKDOCS_CONFIG_PAGES_KEY

public static final String MKDOCS_CONFIG_PAGES_KEY

See Also:

Constant Field Values

MKDOCS_CONFIG_PAGES_API_KEY

public static final String MKDOCS_CONFIG_PAGES_API_KEY

See Also:

Constant Field Values

MKDOCS_FILE_SEPARATOR

public static final String MKDOCS_FILE_SEPARATOR

See Also:

Constant Field Values

MKDOCS_SITE_DIRECTORY

public static final String MKDOCS_SITE_DIRECTORY

See Also:

Constant Field Values

MKDOCS_COMMAND

public static final String MKDOCS_COMMAND

See Also:

Constant Field Values

MKDOCS_BUILD_COMMAND

public static final String MKDOCS_BUILD_COMMAND

See Also:

Constant Field Values

MKDOCS_BUILD_COMMAND_CLEAN_ARGUEMENT

public static final String MKDOCS_BUILD_COMMAND_CLEAN_ARGUEMENT

See Also:

Constant Field Values

MKDOCS_BUILD_COMMAND_CONFIG_FILE_ARGUMENT

public static final String MKDOCS_BUILD_COMMAND_CONFIG_FILE_ARGUMENT

See Also:

Constant Field Values

MKDOCS_BUILD_COMMAND_SITE_DIRECTORY_ARGUMENT

public static final String MKDOCS_BUILD_COMMAND_SITE_DIRECTORY_ARGUMENT

See Also:

Constant Field Values

GIT_REMOTE

public static final String GIT_REMOTE

See Also:

Constant Field Values

GITHUB_URL

public static final String GITHUB_URL

See Also:

Constant Field Values

GITHUB_URL_WITH_USERNAME_PASSWORD

public static final String GITHUB_URL_WITH_USERNAME_PASSWORD

See Also:

Constant Field Values

GIT_MASTER_BRANCH

public static final String GIT_MASTER_BRANCH

See Also:

Constant Field Values

GIT_GH_PAGES_BRANCH

public static final String GIT_GH_PAGES_BRANCH

See Also:

Constant Field Values

GIT_COMMAND

public static final String GIT_COMMAND

See Also:

Constant Field Values

GIT_BRANCH_COMMAND

public static final String GIT_BRANCH_COMMAND

See Also:

Constant Field Values

GIT_BRANCH_COMMAND_OUTPUT_CURRENT_BRANCH_PREFIX

public static final String GIT_BRANCH_COMMAND_OUTPUT_CURRENT_BRANCH_PREFIX

See Also:

Constant Field Values

GIT_STASH_COMMAND

public static final String GIT_STASH_COMMAND

See Also:

Constant Field Values

GIT_STASH_POP_COMMAND

public static final String GIT_STASH_POP_COMMAND

See Also:

Constant Field Values

GIT_ADD_COMMAND

public static final String GIT_ADD_COMMAND

See Also:

Constant Field Values

GIT_PULL_COMMAND

public static final String GIT_PULL_COMMAND

See Also:

Constant Field Values

GIT_PUSH_COMMAND

public static final String GIT_PUSH_COMMAND

See Also:

Constant Field Values

GIT_CHECKOUT_COMMAND

public static final String GIT_CHECKOUT_COMMAND

See Also:

Constant Field Values

GIT_CHECKOUT_COMMAND_ORPHAN_ARGUMENT

public static final String GIT_CHECKOUT_COMMAND_ORPHAN_ARGUMENT

See Also:

Constant Field Values

GIT_COMMIT_COMMAND

public static final String GIT_COMMIT_COMMAND

See Also:

Constant Field Values

GIT_COMMIT_COMMAND_FILES_ARGUMENT

public static final String GIT_COMMIT_COMMAND_FILES_ARGUMENT

See Also:

Constant Field Values

GIT_COMMIT_COMMAND_MESSAGE_ARGUMENT

public static final String GIT_COMMIT_COMMAND_MESSAGE_ARGUMENT

See Also:

Constant Field Values

GIT_COMMIT_COMMAND_MESSAGE_FORMAT

public static final String GIT_COMMIT_COMMAND_MESSAGE_FORMAT

See Also:

Constant Field Values

DEFAULT_CHARSET

public static final Charset DEFAULT_CHARSET

CORE_NAMESPACE

public static final String CORE_NAMESPACE

See Also:

Constant Field Values

SNAPSHOT_VERSION_POSTFIX

public static final String SNAPSHOT_VERSION_POSTFIX

See Also:

Constant Field Values

FREEMARKER_FEATURES_HEADING

public static final String FREEMARKER_FEATURES_HEADING

See Also:

Constant Field Values

FREEMARKER_LATEST_API_DOCS_HEADING

public static final String FREEMARKER_LATEST_API_DOCS_HEADING

See Also:

Constant Field Values

FREEMARKER_SIDDHI_HOME_PAGE

public static final String FREEMARKER_SIDDHI_HOME_PAGE

See Also:

Constant Field Values

FREEMARKER_SIDDHI_REPOSITORY_ARTIFACT_ID

public static final String FREEMARKER_SIDDHI_REPOSITORY_ARTIFACT_ID

See Also:

Constant Field Values

FREEMARKER_EXTENSION_REPOSITORY_PARENT_POSTFIX

public static final String FREEMARKER_EXTENSION_REPOSITORY_PARENT_POSTFIX

See Also:

Constant Field Values

Constructor Detail

Constants

public Constants()