Skip navigation links
E G H I M N O P R S T U 

E

ExampleHelper - Class in org.ops4j.ramler.html.trimou
Trimou helper for rendering RAML examples as pretty-printed JSON strings.
ExampleHelper() - Constructor for class org.ops4j.ramler.html.trimou.ExampleHelper
 
ExampleSpecJsonRenderer - Class in org.ops4j.ramler.html.render
Produces a JsonValue or a pretty-printed JSON string from a RAML ExampleSpec.
ExampleSpecJsonRenderer() - Constructor for class org.ops4j.ramler.html.render.ExampleSpecJsonRenderer
 
execute(Options) - Method in class org.ops4j.ramler.html.trimou.ExampleHelper
 
execute(Options) - Method in class org.ops4j.ramler.html.trimou.TypeLinkHelper
 

G

generate() - Method in class org.ops4j.ramler.html.HtmlGenerator
Generates HTML documentation for the given configuration.
getConfig() - Method in class org.ops4j.ramler.html.HtmlContext
Gets the HTML generator configuration.
getEngine() - Method in class org.ops4j.ramler.html.trimou.TemplateEngine
Constructs a template engine with some additional helpers and lambdas for HTML generation.
getSourceFile() - Method in class org.ops4j.ramler.html.HtmlConfiguration
Gets the top-level RAML source file.
getTargetDir() - Method in class org.ops4j.ramler.html.HtmlConfiguration
Gets the target directory for generated HTML.
getTemplateDir() - Method in class org.ops4j.ramler.html.HtmlConfiguration
Gets the directory with Trimou templates for the HTML generator.
getTemplateDir() - Method in class org.ops4j.ramler.html.trimou.TemplateEngine
Gets the template directory.
getWebResourceDir() - Method in class org.ops4j.ramler.html.HtmlConfiguration
Gets the directory with additional web resources for the HTML generator.

H

HtmlConfiguration - Class in org.ops4j.ramler.html
Configuration of HTML generator.
HtmlConfiguration() - Constructor for class org.ops4j.ramler.html.HtmlConfiguration
 
HtmlContext - Class in org.ops4j.ramler.html
Context for the HTML generator.
HtmlContext(HtmlConfiguration) - Constructor for class org.ops4j.ramler.html.HtmlContext
Constructs a context for the HTML generator from the given configuration.
HtmlGenerator - Class in org.ops4j.ramler.html
Generates HTML documentation from a RAML 1.0 specification.
HtmlGenerator(HtmlConfiguration) - Constructor for class org.ops4j.ramler.html.HtmlGenerator
Creates an HTML generator with the given configuration.

I

invoke(String) - Method in class org.ops4j.ramler.html.trimou.MarkdownLambda
 
invoke(String) - Method in class org.ops4j.ramler.html.trimou.UpperCaseLambda
 

M

MarkdownLambda - Class in org.ops4j.ramler.html.trimou
Converts markdown text to HTML.
MarkdownLambda() - Constructor for class org.ops4j.ramler.html.trimou.MarkdownLambda
 

N

NAME - Static variable in class org.ops4j.ramler.html.trimou.ExampleHelper
 
NAME - Static variable in class org.ops4j.ramler.html.trimou.MarkdownLambda
 
NAME - Static variable in class org.ops4j.ramler.html.trimou.TypeLinkHelper
 
NAME - Static variable in class org.ops4j.ramler.html.trimou.UpperCaseLambda
 
numberOfRequiredParameters() - Method in class org.ops4j.ramler.html.trimou.ExampleHelper
 
numberOfRequiredParameters() - Method in class org.ops4j.ramler.html.trimou.TypeLinkHelper
 

O

org.ops4j.ramler.html - package org.ops4j.ramler.html
HTML generator for RAML APIs.
org.ops4j.ramler.html.render - package org.ops4j.ramler.html.render
HTML renderers for specific API objects.
org.ops4j.ramler.html.trimou - package org.ops4j.ramler.html.trimou
Trimou template engine and helpers for HTML generator.

P

prettyPrint(TypeDeclaration, ExampleSpec) - Method in class org.ops4j.ramler.html.render.ExampleSpecJsonRenderer
Returns a pretty-printed JSON string for the given example instance of the given RAML type.

R

renderTemplate(String, ApiModel) - Method in class org.ops4j.ramler.html.trimou.TemplateEngine
Renders a template of the given name with the given action, using the parameter name action.

S

setSourceFile(String) - Method in class org.ops4j.ramler.html.HtmlConfiguration
Sets the top-level RAML source file.
setTargetDir(String) - Method in class org.ops4j.ramler.html.HtmlConfiguration
Sets the target directory.
setTemplateDir(String) - Method in class org.ops4j.ramler.html.HtmlConfiguration
Sets the template directory.
setTemplateDir(String) - Method in class org.ops4j.ramler.html.trimou.TemplateEngine
Set the template directory.
setWebResourceDir(String) - Method in class org.ops4j.ramler.html.HtmlConfiguration
Sets the web resource directory.

T

TEMPLATE_PATH - Static variable in class org.ops4j.ramler.html.trimou.TemplateEngine
 
TEMPLATE_SUFFIX - Static variable in class org.ops4j.ramler.html.trimou.TemplateEngine
 
TemplateEngine - Class in org.ops4j.ramler.html.trimou
A Trimou template engine configured for HTML generation.
TemplateEngine() - Constructor for class org.ops4j.ramler.html.trimou.TemplateEngine
 
toJsonValue(TypeDeclaration, ExampleSpec) - Method in class org.ops4j.ramler.html.render.ExampleSpecJsonRenderer
Converts an example of the given type to a JSON value.
TypeLinkHelper - Class in org.ops4j.ramler.html.trimou
Trimou helper for rendering links to type names.
TypeLinkHelper() - Constructor for class org.ops4j.ramler.html.trimou.TypeLinkHelper
 

U

UpperCaseLambda - Class in org.ops4j.ramler.html.trimou
Converts text to upper case.
UpperCaseLambda() - Constructor for class org.ops4j.ramler.html.trimou.UpperCaseLambda
 
E G H I M N O P R S T U 
Skip navigation links

Copyright © 2016–2017 OPS4J - Open Participation Software for Java. All rights reserved.