A C D E F G H I L M N O P R S T U V Y

A

API_SUB_DIRECTORY - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

C

CLASS_FILE_EXTENSION - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

CLASSES_DIRECTORY - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

compareTo(ExtensionMetaData) - Method in class org.wso2.siddhi.doc.gen.commons.metadata.ExtensionMetaData

compareTo(NamespaceMetaData) - Method in class org.wso2.siddhi.doc.gen.commons.metadata.NamespaceMetaData

Constants - Class in org.wso2.siddhi.doc.gen.core.utils

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

Constants() - Constructor for class org.wso2.siddhi.doc.gen.core.utils.Constants

CORE_NAMESPACE - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

createExtensionsIndex(List<String>, String, String, String) - Static method in class org.wso2.siddhi.doc.gen.core.utils.DocumentationUtils

Generate a extension index file from the template file

D

DEFAULT_CHARSET - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

deployMkdocsOnGitHubPages(String, File, String, String, String, Log) - Static method in class org.wso2.siddhi.doc.gen.core.utils.DocumentationUtils

Deploy the mkdocs website on GitHub pages

DOCS_DIRECTORY - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

DocumentationUtils - Class in org.wso2.siddhi.doc.gen.core.utils

Utility class for getting the meta data for the extension processors in Siddhi

E

equals(Object) - Method in class org.wso2.siddhi.doc.gen.commons.metadata.ExtensionMetaData

equals(Object) - Method in class org.wso2.siddhi.doc.gen.commons.metadata.NamespaceMetaData

ExampleMetaData - Class in org.wso2.siddhi.doc.gen.commons.metadata

POJO for holding example meta data

ExampleMetaData() - Constructor for class org.wso2.siddhi.doc.gen.commons.metadata.ExampleMetaData

exec(List) - Method in class org.wso2.siddhi.doc.gen.core.freemarker.FormatDescriptionMethod

execute() - Method in class org.wso2.siddhi.doc.gen.core.ExtensionsIndexGenerationMojo

execute() - Method in class org.wso2.siddhi.doc.gen.core.MarkdownDocumentationGenerationMojo

execute() - Method in class org.wso2.siddhi.doc.gen.core.MkdocsGitHubPagesDeployMojo

ExtensionMetaData - Class in org.wso2.siddhi.doc.gen.commons.metadata

POJO for holding extension meta data

ExtensionMetaData() - Constructor for class org.wso2.siddhi.doc.gen.commons.metadata.ExtensionMetaData

ExtensionsIndexGenerationMojo - Class in org.wso2.siddhi.doc.gen.core

Mojo for creating an index Siddhi documentation

ExtensionsIndexGenerationMojo() - Constructor for class org.wso2.siddhi.doc.gen.core.ExtensionsIndexGenerationMojo

ExtensionType - Enum in org.wso2.siddhi.doc.gen.commons.metadata

Enum for holding extension types supported by the doc generator and the free marker templates The enum values should be changed to match the names used in the documentation The enum values will affect the names used in the documentation as well as the hyperlinks These enum values will be passed onto the freemarker templates as a map The other members of the enum class will not be accessible from the freemarker templates These can be accesses using the EXTENSION_TYPE variable eg:- EXTENSION_TYPE.FUNCTION

F

FormatDescriptionMethod - Class in org.wso2.siddhi.doc.gen.core.freemarker

Apache Freemarker method for formatting text This is invoked by the freemarker templates This method escapes relevant html characters, wraps text

FormatDescriptionMethod() - Constructor for class org.wso2.siddhi.doc.gen.core.freemarker.FormatDescriptionMethod

FREEMARKER_EXTENSION_REPOSITORY_PARENT_POSTFIX - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

FREEMARKER_FEATURES_HEADING - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

FREEMARKER_LATEST_API_DOCS_HEADING - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

FREEMARKER_SIDDHI_HOME_PAGE - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

FREEMARKER_SIDDHI_REPOSITORY_ARTIFACT_ID - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

FREEMARKER_TEMPLATE_FILE_EXTENSION - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

G

generateDocumentation(List<NamespaceMetaData>, String, String, Log) - Static method in class org.wso2.siddhi.doc.gen.core.utils.DocumentationUtils

Generate documentation related files using metadata

generateMkdocsSite(File, Log) - Static method in class org.wso2.siddhi.doc.gen.core.utils.DocumentationUtils

Build the mkdocs site using the mkdocs config file

getDefaultValue() - Method in class org.wso2.siddhi.doc.gen.commons.metadata.ParameterMetaData

getDefaultValue() - Method in class org.wso2.siddhi.doc.gen.commons.metadata.SystemParameterMetaData

getDescription() - Method in class org.wso2.siddhi.doc.gen.commons.metadata.ExampleMetaData

getDescription() - Method in class org.wso2.siddhi.doc.gen.commons.metadata.ExtensionMetaData

getDescription() - Method in class org.wso2.siddhi.doc.gen.commons.metadata.ParameterMetaData

getDescription() - Method in class org.wso2.siddhi.doc.gen.commons.metadata.ReturnAttributeMetaData

getDescription() - Method in class org.wso2.siddhi.doc.gen.commons.metadata.SystemParameterMetaData

getExamples() - Method in class org.wso2.siddhi.doc.gen.commons.metadata.ExtensionMetaData

getExtensionMap() - Method in class org.wso2.siddhi.doc.gen.commons.metadata.NamespaceMetaData

getExtensionMetaData(String, List<String>, Log) - Static method in class org.wso2.siddhi.doc.gen.core.utils.DocumentationUtils

Returns the extension extension meta data Gets the meta data from the siddhi manager

getName() - Method in class org.wso2.siddhi.doc.gen.commons.metadata.ExtensionMetaData

getName() - Method in class org.wso2.siddhi.doc.gen.commons.metadata.NamespaceMetaData

getName() - Method in class org.wso2.siddhi.doc.gen.commons.metadata.ParameterMetaData

getName() - Method in class org.wso2.siddhi.doc.gen.commons.metadata.ReturnAttributeMetaData

getName() - Method in class org.wso2.siddhi.doc.gen.commons.metadata.SystemParameterMetaData

getNamespace() - Method in class org.wso2.siddhi.doc.gen.commons.metadata.ExtensionMetaData

getParameters() - Method in class org.wso2.siddhi.doc.gen.commons.metadata.ExtensionMetaData

getPossibleParameters() - Method in class org.wso2.siddhi.doc.gen.commons.metadata.SystemParameterMetaData

getReturnAttributes() - Method in class org.wso2.siddhi.doc.gen.commons.metadata.ExtensionMetaData

getSuperClassMap() - Static method in enum org.wso2.siddhi.doc.gen.commons.metadata.ExtensionType

getSyntax() - Method in class org.wso2.siddhi.doc.gen.commons.metadata.ExampleMetaData

getSystemParameters() - Method in class org.wso2.siddhi.doc.gen.commons.metadata.ExtensionMetaData

getType() - Method in class org.wso2.siddhi.doc.gen.commons.metadata.ParameterMetaData

getType() - Method in class org.wso2.siddhi.doc.gen.commons.metadata.ReturnAttributeMetaData

getValue() - Method in enum org.wso2.siddhi.doc.gen.commons.metadata.ExtensionType

GIT_ADD_COMMAND - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

GIT_BRANCH_COMMAND - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

GIT_BRANCH_COMMAND_OUTPUT_CURRENT_BRANCH_PREFIX - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

GIT_CHECKOUT_COMMAND - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

GIT_CHECKOUT_COMMAND_ORPHAN_ARGUMENT - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

GIT_COMMAND - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

GIT_COMMIT_COMMAND - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

GIT_COMMIT_COMMAND_FILES_ARGUMENT - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

GIT_COMMIT_COMMAND_MESSAGE_ARGUMENT - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

GIT_COMMIT_COMMAND_MESSAGE_FORMAT - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

GIT_GH_PAGES_BRANCH - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

GIT_MASTER_BRANCH - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

GIT_PULL_COMMAND - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

GIT_PUSH_COMMAND - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

GIT_REMOTE - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

GIT_STASH_COMMAND - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

GIT_STASH_POP_COMMAND - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

GITHUB_APACHE_EXTENSION_REPOSITORY_PREFIX - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

GITHUB_GPL_EXTENSION_REPOSITORY_PREFIX - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

GITHUB_OWNER_WSO2_EXTENSIONS - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

GITHUB_URL - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

GITHUB_URL_WITH_USERNAME_PASSWORD - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

H

hashCode() - Method in class org.wso2.siddhi.doc.gen.commons.metadata.ExtensionMetaData

hashCode() - Method in class org.wso2.siddhi.doc.gen.commons.metadata.NamespaceMetaData

HOMEPAGE_FILE_NAME - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

I

isDynamic() - Method in class org.wso2.siddhi.doc.gen.commons.metadata.ParameterMetaData

isOptional() - Method in class org.wso2.siddhi.doc.gen.commons.metadata.ParameterMetaData

L

LATEST_FILE_NAME - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

M

MARKDOWN_DOCUMENTATION_TEMPLATE - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

MARKDOWN_EXTENSIONS_INDEX_TEMPLATE - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

MARKDOWN_FILE_EXTENSION - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

MARKDOWN_HEADINGS_UPDATE_TEMPLATE - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

MarkdownDocumentationGenerationMojo - Class in org.wso2.siddhi.doc.gen.core

Mojo for generating Siddhi Documentation

MarkdownDocumentationGenerationMojo() - Constructor for class org.wso2.siddhi.doc.gen.core.MarkdownDocumentationGenerationMojo

MKDOCS_BUILD_COMMAND - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

MKDOCS_BUILD_COMMAND_CLEAN_ARGUEMENT - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

MKDOCS_BUILD_COMMAND_CONFIG_FILE_ARGUMENT - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

MKDOCS_BUILD_COMMAND_SITE_DIRECTORY_ARGUMENT - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

MKDOCS_COMMAND - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

MKDOCS_CONFIG_FILE_NAME - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

MKDOCS_CONFIG_PAGES_API_KEY - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

MKDOCS_CONFIG_PAGES_KEY - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

MKDOCS_FILE_SEPARATOR - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

MKDOCS_SITE_DIRECTORY - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

MkdocsGitHubPagesDeployMojo - Class in org.wso2.siddhi.doc.gen.core

Mojo for deploying mkdocs website on GitHub pages

MkdocsGitHubPagesDeployMojo() - Constructor for class org.wso2.siddhi.doc.gen.core.MkdocsGitHubPagesDeployMojo

N

NamespaceMetaData - Class in org.wso2.siddhi.doc.gen.commons.metadata

POJO for holding extension meta data

NamespaceMetaData() - Constructor for class org.wso2.siddhi.doc.gen.commons.metadata.NamespaceMetaData

O

org.wso2.siddhi.doc.gen.commons.metadata - package org.wso2.siddhi.doc.gen.commons.metadata

org.wso2.siddhi.doc.gen.core - package org.wso2.siddhi.doc.gen.core

org.wso2.siddhi.doc.gen.core.freemarker - package org.wso2.siddhi.doc.gen.core.freemarker

org.wso2.siddhi.doc.gen.core.utils - package org.wso2.siddhi.doc.gen.core.utils

P

ParameterMetaData - Class in org.wso2.siddhi.doc.gen.commons.metadata

POJO for holding extension parameter meta data

ParameterMetaData() - Constructor for class org.wso2.siddhi.doc.gen.commons.metadata.ParameterMetaData

R

README_FILE_NAME - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

removeSnapshotAPIDocs(File, String, Log) - Static method in class org.wso2.siddhi.doc.gen.core.utils.DocumentationUtils

Remove the snapshot version documentation files from docs/api directory

ReturnAttributeMetaData - Class in org.wso2.siddhi.doc.gen.commons.metadata

POJO for holding extension return attribute meta data

ReturnAttributeMetaData() - Constructor for class org.wso2.siddhi.doc.gen.commons.metadata.ReturnAttributeMetaData

S

setDefaultValue(String) - Method in class org.wso2.siddhi.doc.gen.commons.metadata.ParameterMetaData

setDefaultValue(String) - Method in class org.wso2.siddhi.doc.gen.commons.metadata.SystemParameterMetaData

setDescription(String) - Method in class org.wso2.siddhi.doc.gen.commons.metadata.ExampleMetaData

setDescription(String) - Method in class org.wso2.siddhi.doc.gen.commons.metadata.ExtensionMetaData

setDescription(String) - Method in class org.wso2.siddhi.doc.gen.commons.metadata.ParameterMetaData

setDescription(String) - Method in class org.wso2.siddhi.doc.gen.commons.metadata.ReturnAttributeMetaData

setDescription(String) - Method in class org.wso2.siddhi.doc.gen.commons.metadata.SystemParameterMetaData

setDynamic(boolean) - Method in class org.wso2.siddhi.doc.gen.commons.metadata.ParameterMetaData

setExamples(List<ExampleMetaData>) - Method in class org.wso2.siddhi.doc.gen.commons.metadata.ExtensionMetaData

setExtensionMap(TreeMap<String, List<ExtensionMetaData>>) - Method in class org.wso2.siddhi.doc.gen.commons.metadata.NamespaceMetaData

setName(String) - Method in class org.wso2.siddhi.doc.gen.commons.metadata.ExtensionMetaData

setName(String) - Method in class org.wso2.siddhi.doc.gen.commons.metadata.NamespaceMetaData

setName(String) - Method in class org.wso2.siddhi.doc.gen.commons.metadata.ParameterMetaData

setName(String) - Method in class org.wso2.siddhi.doc.gen.commons.metadata.ReturnAttributeMetaData

setName(String) - Method in class org.wso2.siddhi.doc.gen.commons.metadata.SystemParameterMetaData

setNamespace(String) - Method in class org.wso2.siddhi.doc.gen.commons.metadata.ExtensionMetaData

setOptional(boolean) - Method in class org.wso2.siddhi.doc.gen.commons.metadata.ParameterMetaData

setParameters(List<ParameterMetaData>) - Method in class org.wso2.siddhi.doc.gen.commons.metadata.ExtensionMetaData

setPossibleParameters(List<String>) - Method in class org.wso2.siddhi.doc.gen.commons.metadata.SystemParameterMetaData

setReturnAttributes(List<ReturnAttributeMetaData>) - Method in class org.wso2.siddhi.doc.gen.commons.metadata.ExtensionMetaData

setSyntax(String) - Method in class org.wso2.siddhi.doc.gen.commons.metadata.ExampleMetaData

setSystemParameters(List<SystemParameterMetaData>) - Method in class org.wso2.siddhi.doc.gen.commons.metadata.ExtensionMetaData

setType(List<DataType>) - Method in class org.wso2.siddhi.doc.gen.commons.metadata.ParameterMetaData

setType(List<DataType>) - Method in class org.wso2.siddhi.doc.gen.commons.metadata.ReturnAttributeMetaData

SNAPSHOT_VERSION_POSTFIX - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

SYSTEM_PROPERTY_SCM_PASSWORD_KEY - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

SYSTEM_PROPERTY_SCM_USERNAME_KEY - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

SystemParameterMetaData - Class in org.wso2.siddhi.doc.gen.commons.metadata

POJO for holding extension system parameters meta data

SystemParameterMetaData() - Constructor for class org.wso2.siddhi.doc.gen.commons.metadata.SystemParameterMetaData

T

TEMPLATES_DIRECTORY - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

U

updateAPIPagesInMkdocsConfig(File, String) - Static method in class org.wso2.siddhi.doc.gen.core.utils.DocumentationUtils

This add a new page to the list of pages in the mkdocs configuration

updateDocumentationOnGitHub(String, File, File, String, Log) - Static method in class org.wso2.siddhi.doc.gen.core.utils.DocumentationUtils

Commit the documentation directory and the mkdocs config file

updateHeadingsInMarkdownFile(File, File, String, String, List<NamespaceMetaData>) - Static method in class org.wso2.siddhi.doc.gen.core.utils.DocumentationUtils

Update the documentation home page

V

valueOf(String) - Static method in enum org.wso2.siddhi.doc.gen.commons.metadata.ExtensionType

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

values() - Static method in enum org.wso2.siddhi.doc.gen.commons.metadata.ExtensionType

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

Y

YAML_FILE_EXTENSION - Static variable in class org.wso2.siddhi.doc.gen.core.utils.Constants

A C D E F G H I L M N O P R S T U V Y