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

A

add(String, String, String) - Method in class io.siddhi.doc.gen.extensions.ExtensionDocCache

The add method adds an extension with description and last modified date to the cache.

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

B

build() - Method in class io.siddhi.doc.gen.extensions.githubclient.GithubContentsClient.Builder

Builder(String, String) - Constructor for class io.siddhi.doc.gen.extensions.githubclient.GithubContentsClient.Builder

C

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

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

commit() - Method in class io.siddhi.doc.gen.extensions.ExtensionDocCache

The commit method writes the data to the given location in the local storage.

compareTo(ExtensionMetaData) - Method in class io.siddhi.doc.gen.metadata.ExtensionMetaData

compareTo(NamespaceMetaData) - Method in class io.siddhi.doc.gen.metadata.NamespaceMetaData

Constants - Class in io.siddhi.doc.gen.core.utils

Constants used by the doc generator and the free marker templates

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

content - Variable in class io.siddhi.doc.gen.extensions.githubclient.ContentsBodyReader

The C type content.

ContentsBodyReader<C> - Class in io.siddhi.doc.gen.extensions.githubclient

The ContentsBodyReader class offers ability to read from a C type response body from a Github Contents API response.

ContentsResponse<T> - Class in io.siddhi.doc.gen.extensions.githubclient

The ContentsResponse class represents an abstract view of the Github Contents API response.

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

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

Generate a extension index file from the template file

D

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

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

Deploy the mkdocs website on GitHub pages

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

DocumentationUtils - Class in io.siddhi.doc.gen.core.utils

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

E

equals(Object) - Method in class io.siddhi.doc.gen.metadata.ExtensionMetaData

equals(Object) - Method in class io.siddhi.doc.gen.metadata.NamespaceMetaData

ExampleMetaData - Class in io.siddhi.doc.gen.metadata

POJO for holding example meta data

ExampleMetaData() - Constructor for class io.siddhi.doc.gen.metadata.ExampleMetaData

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

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

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

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

ExtensionDocCache - Class in io.siddhi.doc.gen.extensions

The ExtensionDocCache class works as the main manipulator of underline API response cache.

ExtensionDocCache(Path) - Constructor for class io.siddhi.doc.gen.extensions.ExtensionDocCache

Constructs a ExtensionDocCache instance.

ExtensionDocRetriever - Class in io.siddhi.doc.gen.extensions

The ExtensionDocRetriever class provides ability to retrieve all the descriptions for Siddhi extensions.

ExtensionDocRetriever(String, List<String>, ExtensionDocCache) - Constructor for class io.siddhi.doc.gen.extensions.ExtensionDocRetriever

ExtensionMetaData - Class in io.siddhi.doc.gen.metadata

POJO for holding extension meta data

ExtensionMetaData() - Constructor for class io.siddhi.doc.gen.metadata.ExtensionMetaData

ExtensionsIndexGenerationMojo - Class in io.siddhi.doc.gen.core

Mojo for creating an index Siddhi documentation

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

ExtensionType - Enum in io.siddhi.doc.gen.metadata

Enum for holding extension types supported by the doc generator and the free marker templates

F

FormatDescriptionMethod - Class in io.siddhi.doc.gen.core.freemarker

Apache Freemarker method for formatting text This is invoked by the freemarker templates

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

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

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

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

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

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

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

G

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

Generate documentation related files using metadata

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

Build the mkdocs site using the mkdocs config file

getContent() - Method in class io.siddhi.doc.gen.extensions.githubclient.ContentsResponse

getContent() - Method in class io.siddhi.doc.gen.extensions.githubclient.HtmlContentsResponse

getContentsBodyReader() - Method in class io.siddhi.doc.gen.extensions.githubclient.ContentsResponse

getContentsResponse(Class<T>) - Method in class io.siddhi.doc.gen.extensions.githubclient.GithubContentsClient

The getContentsResponse method returns an instance of class T which extends the ContentsResponse class.

getDefaultValue() - Method in class io.siddhi.doc.gen.metadata.ParameterMetaData

getDefaultValue() - Method in class io.siddhi.doc.gen.metadata.SystemParameterMetaData

getDescription() - Method in class io.siddhi.doc.gen.metadata.ExampleMetaData

getDescription() - Method in class io.siddhi.doc.gen.metadata.ExtensionMetaData

getDescription() - Method in class io.siddhi.doc.gen.metadata.ParameterMetaData

getDescription() - Method in class io.siddhi.doc.gen.metadata.ReturnAttributeMetaData

getDescription() - Method in class io.siddhi.doc.gen.metadata.SystemParameterMetaData

getError() - Method in class io.siddhi.doc.gen.extensions.githubclient.ContentsResponse

Because of all API error responses are in JSON format the getError method always returns an instance of org.json.JSONObject.

getExamples() - Method in class io.siddhi.doc.gen.metadata.ExtensionMetaData

getExtensionDescriptionMap() - Method in class io.siddhi.doc.gen.extensions.ExtensionDocCache

The getExtensionDescriptionMap method returns a map of extensions with extension name as key and extension description as value.

getExtensionMap() - Method in class io.siddhi.doc.gen.metadata.NamespaceMetaData

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

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

getFirstParagraph() - Method in class io.siddhi.doc.gen.extensions.githubclient.ContentsBodyReader

Extract the first paragraph from the whole content body and return it as a String.

getHeader(String) - Method in class io.siddhi.doc.gen.extensions.githubclient.ContentsResponse

getLastModifiedDateTime(String) - Method in class io.siddhi.doc.gen.extensions.ExtensionDocCache

The getLastModifiedDateTime returns the last modified date a given extension.

getName() - Method in class io.siddhi.doc.gen.metadata.ExtensionMetaData

getName() - Method in class io.siddhi.doc.gen.metadata.NamespaceMetaData

getName() - Method in class io.siddhi.doc.gen.metadata.ParameterMetaData

getName() - Method in class io.siddhi.doc.gen.metadata.ReturnAttributeMetaData

getName() - Method in class io.siddhi.doc.gen.metadata.SystemParameterMetaData

getNamespace() - Method in class io.siddhi.doc.gen.metadata.ExtensionMetaData

getParameters() - Method in class io.siddhi.doc.gen.metadata.ExtensionMetaData

getPossibleParameters() - Method in class io.siddhi.doc.gen.metadata.SystemParameterMetaData

getReturnAttributes() - Method in class io.siddhi.doc.gen.metadata.ExtensionMetaData

getStatus() - Method in class io.siddhi.doc.gen.extensions.githubclient.ContentsResponse

getSuperClassMap() - Static method in enum io.siddhi.doc.gen.metadata.ExtensionType

getSyntax() - Method in class io.siddhi.doc.gen.metadata.ExampleMetaData

getSystemParameters() - Method in class io.siddhi.doc.gen.metadata.ExtensionMetaData

getType() - Method in class io.siddhi.doc.gen.metadata.ParameterMetaData

getType() - Method in class io.siddhi.doc.gen.metadata.ReturnAttributeMetaData

getValue() - Method in enum io.siddhi.doc.gen.metadata.ExtensionType

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

GithubContentsClient - Class in io.siddhi.doc.gen.extensions.githubclient

The GithubContentsClient class offers the ability to make requests to fetch certain contents from Github using Github Contents REST API.

GithubContentsClient.Builder - Class in io.siddhi.doc.gen.extensions.githubclient

The GithubContentsClient builder.

H

has(String) - Method in class io.siddhi.doc.gen.extensions.ExtensionDocCache

Return whether extension exists in the cache.

hashCode() - Method in class io.siddhi.doc.gen.metadata.ExtensionMetaData

hashCode() - Method in class io.siddhi.doc.gen.metadata.NamespaceMetaData

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

HtmlContentsResponse - Class in io.siddhi.doc.gen.extensions.githubclient

The HtmlContentsResponse class holds a response with a HTML type body.

I

io.siddhi.doc.gen.core - package io.siddhi.doc.gen.core

io.siddhi.doc.gen.core.freemarker - package io.siddhi.doc.gen.core.freemarker

io.siddhi.doc.gen.core.utils - package io.siddhi.doc.gen.core.utils

io.siddhi.doc.gen.extensions - package io.siddhi.doc.gen.extensions

io.siddhi.doc.gen.extensions.githubclient - package io.siddhi.doc.gen.extensions.githubclient

io.siddhi.doc.gen.metadata - package io.siddhi.doc.gen.metadata

isDynamic() - Method in class io.siddhi.doc.gen.metadata.ParameterMetaData

isInMemory() - Method in class io.siddhi.doc.gen.extensions.ExtensionDocCache

isOptional() - Method in class io.siddhi.doc.gen.metadata.ParameterMetaData

isReadme(boolean) - Method in class io.siddhi.doc.gen.extensions.githubclient.GithubContentsClient.Builder

isThrottled() - Method in class io.siddhi.doc.gen.extensions.ExtensionDocRetriever

L

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

M

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

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

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

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

MarkdownDocumentationGenerationMojo - Class in io.siddhi.doc.gen.core

Mojo for generating Siddhi Documentation

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

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

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

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

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

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

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

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

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

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

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

MkdocsGitHubPagesDeployMojo - Class in io.siddhi.doc.gen.core

Mojo for deploying mkdocs website on GitHub pages

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

N

NamespaceMetaData - Class in io.siddhi.doc.gen.metadata

POJO for holding extension meta data

NamespaceMetaData() - Constructor for class io.siddhi.doc.gen.metadata.NamespaceMetaData

P

ParameterMetaData - Class in io.siddhi.doc.gen.metadata

POJO for holding extension parameter meta data

ParameterMetaData() - Constructor for class io.siddhi.doc.gen.metadata.ParameterMetaData

path(String) - Method in class io.siddhi.doc.gen.extensions.githubclient.GithubContentsClient.Builder

pull() - Method in class io.siddhi.doc.gen.extensions.ExtensionDocRetriever

The pull method retrieves corresponding descriptions from extension repositories.

Q

queryParam(String, String) - Method in class io.siddhi.doc.gen.extensions.githubclient.GithubContentsClient.Builder

R

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

remove(String) - Method in class io.siddhi.doc.gen.extensions.ExtensionDocCache

Remove an extension from the cache.

removeComplementOf(Set<String>) - Method in class io.siddhi.doc.gen.extensions.ExtensionDocCache

Remove relative complement of the given extension set from the extension set in the cache.

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

Remove the snapshot version documentation files from docs/api directory

ReturnAttributeMetaData - Class in io.siddhi.doc.gen.metadata

POJO for holding extension return attribute meta data

ReturnAttributeMetaData() - Constructor for class io.siddhi.doc.gen.metadata.ReturnAttributeMetaData

S

setDefaultValue(String) - Method in class io.siddhi.doc.gen.metadata.ParameterMetaData

setDefaultValue(String) - Method in class io.siddhi.doc.gen.metadata.SystemParameterMetaData

setDescription(String) - Method in class io.siddhi.doc.gen.metadata.ExampleMetaData

setDescription(String) - Method in class io.siddhi.doc.gen.metadata.ExtensionMetaData

setDescription(String) - Method in class io.siddhi.doc.gen.metadata.ParameterMetaData

setDescription(String) - Method in class io.siddhi.doc.gen.metadata.ReturnAttributeMetaData

setDescription(String) - Method in class io.siddhi.doc.gen.metadata.SystemParameterMetaData

setDynamic(boolean) - Method in class io.siddhi.doc.gen.metadata.ParameterMetaData

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

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

setHeader(String, String) - Method in class io.siddhi.doc.gen.extensions.githubclient.GithubContentsClient

Sets a header in HTTPS request.

setName(String) - Method in class io.siddhi.doc.gen.metadata.ExtensionMetaData

setName(String) - Method in class io.siddhi.doc.gen.metadata.NamespaceMetaData

setName(String) - Method in class io.siddhi.doc.gen.metadata.ParameterMetaData

setName(String) - Method in class io.siddhi.doc.gen.metadata.ReturnAttributeMetaData

setName(String) - Method in class io.siddhi.doc.gen.metadata.SystemParameterMetaData

setNamespace(String) - Method in class io.siddhi.doc.gen.metadata.ExtensionMetaData

setOptional(boolean) - Method in class io.siddhi.doc.gen.metadata.ParameterMetaData

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

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

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

setSyntax(String) - Method in class io.siddhi.doc.gen.metadata.ExampleMetaData

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

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

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

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

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

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

SystemParameterMetaData - Class in io.siddhi.doc.gen.metadata

POJO for holding extension system parameters meta data

SystemParameterMetaData() - Constructor for class io.siddhi.doc.gen.metadata.SystemParameterMetaData

T

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

U

updateAPIPagesInMkdocsConfig(File, String) - Static method in class io.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 io.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 io.siddhi.doc.gen.core.utils.DocumentationUtils

Update the documentation home page

V

valueOf(String) - Static method in enum io.siddhi.doc.gen.metadata.ExtensionType

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

values() - Static method in enum io.siddhi.doc.gen.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 io.siddhi.doc.gen.core.utils.Constants

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