|
||||||||||
PREV NEXT | FRAMES NO FRAMES All Classes |
Document
builders that add element location information into the generated element nodes.AbstractJavaEntity
)
using an AOP-like expressions syntax to select classes, methods and fields.NodeList
to a java list of Node
instances.
Globals.attachBinaryContent(URL)
.
Globals.attachBinaryContent(String, URL)
.
Globals.attachBinaryContent(String, URL)
.
Globals.attachBinaryContent(String, java.io.InputStream)
.
Globals.attachBinaryContent(String, java.io.InputStream)
.
BrushResolver
defines an interface that may be implemented and registered via service loading to register additional
javascript brushes (= language support) for the syntax highlighting library.EasyFactoryConfiguration
.
highlight("css", code)
.
VelocityConfigurator
which sets various defaults.DirectoryLoader.PARAM_ALIAS
" alias functionality.RequestParameterTransformer.TRANSFORMERS
).
InterfaceScanner.LEGACY_PARAM_ALIAS
" alias functionality.RequestParameterTransformer.TRANSFORMERS
).
highlight("java", code)
.
JavaSourceLoader.PARAM_ALIAS
" alias functionality.RequestParameterTransformer.TRANSFORMERS
).
highlight("js", code)
.
highlight("html/jsp", code)
.
Node.getUserData(String)
) that may be used to return the column number of an element node.
Node.getUserData(String)
) that may be used to return the line number of an element node.
InitializeMacroMojo
.InitializeMacroMojo
.RequestParameterTransformer
that is triggered when the parameter
"message-box
" is set with the macro call."constants"
presented as Map<String,Map<?
"declaredConstants"
presented as Map<String,Map<?
"declaredFields"
presented as Map<String,Map<?
Document
) and can be accessed from velocity templates.
Document
) and can be accessed from velocity templates.
"fields"
presented as Map<String,Map<?
"interfaceMethods"
presented as Map<String,Map<?
JavaClass
instance of the specified class and allows
accessing the QDox reflection model directly.
Properties
instance.
new SelectableArrayList
<String>(new TreeSet<String>(properties.keySet()));
).
"methods"
presented as Map<String,Map<?
xpath
" but configured to match on the original document.
"properties"
presented as Map<String,Map<?
JavaSourceLoader.Selector
that may be used to access nested, super, implemented and derived classes.
XmlLoader
for details.
XPathEvaluator
" that is configured to match xpath expressions
against DOM tree of document
.
<?
PARAM_ADD_XSL - Static variable in class org.tinyjee.maven.dim.extensions.XmlLoader
Optional parameter, sets a relative or absolute URL to an XSL file that is added as standard template to the document being included but it is not executed.
PARAM_ALIAS - Static variable in class org.tinyjee.maven.dim.extensions.DirectoryLoader
Defines a shortcut for the request properties 'source-class' and 'directories'.
PARAM_ALIAS - Static variable in class org.tinyjee.maven.dim.extensions.JavaSourceLoader
Defines a shortcut for the request properties 'source-class' and 'java-source'.
PARAM_ALIAS - Static variable in class org.tinyjee.maven.dim.extensions.PropertiesLoader
Defines a shortcut for the request properties 'source-class
' and 'properties
'.
PARAM_ALIAS - Static variable in class org.tinyjee.maven.dim.extensions.ScriptInvoker
Defines a shortcut for the request properties 'source-class' and 'script'.
PARAM_ALIAS - Static variable in class org.tinyjee.maven.dim.extensions.SvgLoader
Defines a shortcut for the request properties 'source-class' and 'svg'.
PARAM_ALIAS - Static variable in class org.tinyjee.maven.dim.extensions.XmlLoader
Defines a shortcut for the request properties 'source-class' and 'xml'.
PARAM_API_DOCS - Static variable in class org.tinyjee.maven.dim.extensions.JavaSourceLoader
Optional input parameter specifying the standard path to the apidocs to use when linking via {@link} or {@linkplain}.
PARAM_ATTACH - Static variable in class org.tinyjee.maven.dim.extensions.SvgLoader
Specifies whether the SVG is attached to the page (instead of copied straight to the document).
PARAM_BACKGROUND_COLOR - Static variable in class org.tinyjee.maven.dim.extensions.MessageBoxParameterTransformer
Optional parameter overriding the color of the message box background.
PARAM_CELL_STYLE - Static variable in class org.tinyjee.maven.dim.extensions.TableLayoutParameterTransformer
Optional Parameter: Defines the CSS style of the TD elements.
PARAM_CHARSET - Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
Defines the charset to use when loading the source content.
PARAM_CHARSET_AUTODETECT - Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
Toggles whether charset detection is used when loading source content.
PARAM_COLOR - Static variable in class org.tinyjee.maven.dim.extensions.MessageBoxParameterTransformer
Optional parameter overriding the border color of the message box.
PARAM_COLUMN_CLASSES - Static variable in class org.tinyjee.maven.dim.extensions.TableLayoutParameterTransformer
Optional Parameter: Specifies a comma separates list of classes to apply with the columns.
PARAM_COLUMN_WIDTHS - Static variable in class org.tinyjee.maven.dim.extensions.TableLayoutParameterTransformer
Optional Parameter: Specifies a comma separates list of width values (CSS format) to apply with the columns.
PARAM_COLUMNS - Static variable in class org.tinyjee.maven.dim.extensions.TableLayoutParameterTransformer
Specifies the number of columns to render (defaults to '*
').
PARAM_DIRECTION - Static variable in class org.tinyjee.maven.dim.extensions.TableLayoutParameterTransformer
Defines the direction for placing the sections in the table layout (defaults to 'top-down
').
PARAM_DIRECTORIES - Static variable in class org.tinyjee.maven.dim.extensions.DirectoryLoader
Sets a comma separated list of URL or local path pointing to directories to load recursively.
PARAM_FILE - Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
Sets the source path using java.io.File
instead of evaluating it against URL or File paths.
PARAM_GAP - Static variable in class org.tinyjee.maven.dim.extensions.TableLayoutParameterTransformer
Defines the gab (margin) between the table cells (defaults to '10pt
').
PARAM_HEIGHT - Static variable in class org.tinyjee.maven.dim.extensions.SvgLoader
Optional Parameter, sets the height in pixel.
PARAM_HIDE_TITLES - Static variable in class org.tinyjee.maven.dim.extensions.TabbedPanelParameterTransformer
Toggles whether section titles are hidden once they were transformed into a tab (defaults to 'true').
PARAM_HIGHLIGHT - Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
Deprecated.
PARAM_HIGHLIGHT_LINES - Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
Defines lines to highlight inside verbatim content using the same selection logic as used within the "snippet
" parameter.
PARAM_HIGHLIGHT_THEME - Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
Sets the highlighting color theme to use.
PARAM_HIGHLIGHT_TYPE - Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
Sets the highlighter (brush) to use when highlighting verbatim content.
PARAM_ICON - Static variable in class org.tinyjee.maven.dim.extensions.MessageBoxParameterTransformer
Optional parameter setting a site resource path to the image that is used with the message box instead of the built-in SVG graphics.
PARAM_INDENT - Static variable in class org.tinyjee.maven.dim.extensions.XmlLoader
Optional parameter, toggles whether the XML is indented before inclusion.
PARAM_INLINE_CSS - Static variable in class org.tinyjee.maven.dim.extensions.InlineCssParameterTransformer
Enables this extension and sets the content to place inside the inlined "<style>" element.
PARAM_INLINE_SCRIPT - Static variable in class org.tinyjee.maven.dim.extensions.InlineScriptParameterTransformer
Enables this extension and sets the content to place inside the inlined "<script>" element.
PARAM_JAVA_SOURCE - Static variable in class org.tinyjee.maven.dim.extensions.JavaSourceLoader
Is the expected input parameter that points to the class or interface to scan.
PARAM_JSON - Static variable in class org.tinyjee.maven.dim.extensions.XmlLoader
Experimental: Sets the URL or local path to JSON encoded content that is translated to XML and included.
PARAM_LOAD_SCHEMA - Static variable in class org.tinyjee.maven.dim.extensions.XmlLoader
Enum parameter that specifies whether XML schemata are loaded in order to include them with the XML content.
PARAM_MESSAGE_BOX - Static variable in class org.tinyjee.maven.dim.extensions.MessageBoxParameterTransformer
Enables this extension and sets the text to display inside the message box.
PARAM_MIN_HEIGHT - Static variable in class org.tinyjee.maven.dim.extensions.TabbedPanelParameterTransformer
Optional Parameter: Specifies a minimum tab height to improve scrolling behaviour when switching tabs.
PARAM_NAMESPACE_AWARE - Static variable in class org.tinyjee.maven.dim.extensions.XmlLoader
Optional parameter, toggles whether the XML parser handles namespaces.
PARAM_NO_CACHE - Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
Forces the re-loading of source content when set to true
.
PARAM_OUT_FILES - Static variable in class org.tinyjee.maven.dim.extensions.DirectoryLoader
Is set with a selectable list of FileReference
instances of all files that were found in the given directories.
PARAM_OUT_JAVA_CLASSES - Static variable in class org.tinyjee.maven.dim.extensions.DirectoryLoader
Is set with a selectable list of all java classes found in the given directories.
PARAM_OUT_PROPERTY_FILES - Static variable in class org.tinyjee.maven.dim.extensions.DirectoryLoader
Is set with a selectable list of FileReference
instances of all XML files that were found in the given directories.
PARAM_OUT_XML_FILES - Static variable in class org.tinyjee.maven.dim.extensions.DirectoryLoader
Is set with a selectable list of FileReference
instances of all XML files that were found in the given directories.
PARAM_OVERWRITE - Static variable in class org.tinyjee.maven.dim.extensions.JavaSourceLoader
Optional boolean input parameter specifying whether the extension overwrites other input parameters.
PARAM_PAD_LINE_NUMBERS - Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
Pads all line numbers by the specified amount of zeros (if gutter is shown).
PARAM_PROPERTIES - Static variable in class org.tinyjee.maven.dim.extensions.PropertiesLoader
Sets the path to the properties file to load inside the request parameters.
PARAM_RENDER - Static variable in class org.tinyjee.maven.dim.extensions.SvgLoader
Specifies whether the SVG is rendered to an image and included.
PARAM_RENDER_BACKGROUND - Static variable in class org.tinyjee.maven.dim.extensions.SvgLoader
Specifies a background color to use when rendering an SVG to an image.
PARAM_RENDER_MEDIA - Static variable in class org.tinyjee.maven.dim.extensions.SvgLoader
Specifies the CSS media when rendering an SVG containing CSS stylesheets with alternating media styles.
PARAM_ROW_CLASSES - Static variable in class org.tinyjee.maven.dim.extensions.TableLayoutParameterTransformer
Optional Parameter: Specifies a comma separates list of classes to apply with the rows.
PARAM_ROW_HEIGHTS - Static variable in class org.tinyjee.maven.dim.extensions.TableLayoutParameterTransformer
Optional Parameter: Specifies a comma separates list of height values (CSS format) to apply with the rows.
PARAM_ROWS - Static variable in class org.tinyjee.maven.dim.extensions.TableLayoutParameterTransformer
Specifies the number of rows to render (defaults to '*
').
PARAM_SCRIPT - Static variable in class org.tinyjee.maven.dim.extensions.ScriptInvoker
Sets the URL or local path to the script file to load and evaluate.
PARAM_SCRIPT_TYPE - Static variable in class org.tinyjee.maven.dim.extensions.InlineScriptParameterTransformer
Defines the language of the script to include, defaults to "javascript".
PARAM_SET_FIRST_LINE - Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
Sets the line number to use for the first line (if gutter is shown).
PARAM_SHOW_GUTTER - Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
Toggles whether the gutter including line numbers is shown for verbatim content.
PARAM_SITE_DIRECTORY - Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
Deprecated.
PARAM_SNIPPET - Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
Sets one or more comma separated expression to select the content snippets to include.
PARAM_SNIPPET_END_OFFSET - Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
Optional parameter that can be used to grow the end of snippet selections by the given amount of lines.
PARAM_SNIPPET_GROW_EXCLUDES - Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
Optional boolean parameter that toggles whether growing is applied to exclusions as well.
PARAM_SNIPPET_GROW_OFFSET - Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
Optional parameter that can be used to grow snippet selections by the given amount of lines.
PARAM_SNIPPET_ID - Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
Deprecated.
PARAM_SNIPPET_START_OFFSET - Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
Optional parameter that can be used to grow the start of snippet selections by the given amount of lines.
PARAM_SOURCE - Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
Sets the content to include using a source path, source URL or the fully qualified java class name.
PARAM_SOURCE_CLASS - Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
Sets a class to use as dynamic source for content, request parameters or both.
PARAM_SOURCE_CONTENT - Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
Sets the source content inline with the macro call.
PARAM_SOURCE_CONTENT_TYPE - Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
Sets the content type of the source.
PARAM_SOURCE_IS_TEMPLATE - Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
Toggles whether the source content is treated as a Velocity template.
PARAM_STYLE - Static variable in class org.tinyjee.maven.dim.extensions.TableLayoutParameterTransformer
Optional Parameter: Defines the CSS style of the container hosting the elements.
PARAM_STYLE_CLASS - Static variable in class org.tinyjee.maven.dim.extensions.TableLayoutParameterTransformer
Optional Parameter: Defines the CSS style class of the container hosting the elements.
PARAM_SVG - Static variable in class org.tinyjee.maven.dim.extensions.SvgLoader
Sets the URL or local path to the SVG file to load inside the request parameters.
PARAM_TABBED_PANEL - Static variable in class org.tinyjee.maven.dim.extensions.TabbedPanelParameterTransformer
Enables this extension and sets a regular expression matching the section titles that should be transformed into a tabs.
PARAM_TABLE_LAYOUT - Static variable in class org.tinyjee.maven.dim.extensions.TableLayoutParameterTransformer
Enables this extension and sets a regular expression matching the section titles that should be transformed into a tabs.
PARAM_TEXT_COLOR - Static variable in class org.tinyjee.maven.dim.extensions.MessageBoxParameterTransformer
Optional parameter overriding the text color of the message box.
PARAM_TYPE - Static variable in class org.tinyjee.maven.dim.extensions.MessageBoxParameterTransformer
Optional parameter specifying the type of message box to display.
PARAM_VERBATIM - Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
Toggles whether the content is verbatim (included as source) or non-verbatim (included as markup and interpreted).
PARAM_WIDTH - Static variable in class org.tinyjee.maven.dim.extensions.SvgLoader
Optional Parameter, sets the width in pixel.
PARAM_WIDTH - Static variable in class org.tinyjee.maven.dim.extensions.TableLayoutParameterTransformer
Defines the width of the layout (defaults to '100%
').
PARAM_XML - Static variable in class org.tinyjee.maven.dim.extensions.XmlLoader
Sets the URL or local path to the XML file to load inside the request parameters.
PARAM_XML_CLASS - Static variable in class org.tinyjee.maven.dim.extensions.XmlLoader
Sets a fully qualified class name to a class that either provides a Document
instance, a Source
or is annotated with XmlRootElement
.
PARAM_XSL - Static variable in class org.tinyjee.maven.dim.extensions.SvgLoader
Optional Parameter, transform the given input (e.g.
PARAM_XSL - Static variable in class org.tinyjee.maven.dim.extensions.XmlLoader
Optional parameter, sets the path to an XSL file that is used to transform the given input.
parameters - Variable in class org.tinyjee.maven.dim.spi.AbstractSource
parse(URL) - Method in class org.tinyjee.maven.dim.utils.AbstractPositioningDocumentBuilder
Parses the given URL to a Document
.
parse(URL, Reader) - Method in class org.tinyjee.maven.dim.utils.AbstractPositioningDocumentBuilder
Parses the given URL to a Document
.
parse(URL) - Method in class org.tinyjee.maven.dim.utils.PositioningDocumentBuilder
Parses the given XML document.
parse(URL, Reader) - Method in class org.tinyjee.maven.dim.utils.PositioningDocumentBuilder
parse(URL) - Method in class org.tinyjee.maven.dim.utils.PositioningJsonDocumentBuilder
parse(URL, Reader) - Method in class org.tinyjee.maven.dim.utils.PositioningJsonDocumentBuilder
parseCallStack(String) - Static method in class org.tinyjee.maven.dim.utils.ClassUtils
PositioningDocumentBuilder - Class in org.tinyjee.maven.dim.utils
Creates a Document
builder that adds user-data into the parsed DOM nodes that covers line number and column information.
PositioningDocumentBuilder(boolean) - Constructor for class org.tinyjee.maven.dim.utils.PositioningDocumentBuilder
Creates a new document builder that adds line and column number to the user data sections of resulting element nodes.
PositioningJsonDocumentBuilder - Class in org.tinyjee.maven.dim.utils
Creates a Document
builder that parses JSON instead of XML and adds user-data into the parsed DOM nodes that covers line number and column information.
PositioningJsonDocumentBuilder() - Constructor for class org.tinyjee.maven.dim.utils.PositioningJsonDocumentBuilder
PrintableMap<K,V> - Class in org.tinyjee.maven.dim.utils
Extends LinkedHashMap with the ability to print the map's contents as formatted string.
PrintableMap(String) - Constructor for class org.tinyjee.maven.dim.utils.PrintableMap
PrintableMap(Map<? extends K, ? extends V>, String) - Constructor for class org.tinyjee.maven.dim.utils.PrintableMap
printContent() - Method in class org.tinyjee.maven.dim.utils.PrintableMap
processJavaDocComment(String) - Method in class org.tinyjee.maven.dim.extensions.JavaDocTagsHandler
Processes all inline tags inside the javadoc comment.
processRawContent(Source, SortedMap<Integer, List<String>>, Sink) - Method in class org.tinyjee.maven.dim.IncludeMacro
Sends raw text to the sink.
processSource(Map<String, String>, File, Source, Sink) - Method in class org.tinyjee.maven.dim.IncludeMacro
Processes the given source to the Sink.
PropertiesLoader - Class in org.tinyjee.maven.dim.extensions
PropertiesLoader is a 'source-class' compatible helper class that can load a properties file and add or overwrite the request properties by the properties contained in the file.
PropertiesLoader(File, Map<String, Object>) - Constructor for class org.tinyjee.maven.dim.extensions.PropertiesLoader
Constructs a new properties loader searching for properties using the given base path.
PropertiesLoader - Class in org.tinyjee.maven.dim.utils
Deprecated.
PropertiesLoader(File, Map<String, Object>) - Constructor for class org.tinyjee.maven.dim.utils.PropertiesLoader
Deprecated.
PropertiesLoader.AliasHandler - Class in org.tinyjee.maven.dim.extensions
Implements the "PropertiesLoader.PARAM_ALIAS
" alias functionality.
PropertiesLoader.AliasHandler() - Constructor for class org.tinyjee.maven.dim.extensions.PropertiesLoader.AliasHandler
Constructs the handler (Note: Is called by RequestParameterTransformer.TRANSFORMERS
).
put(String, String) - Method in class org.tinyjee.maven.dim.sources.AbstractParametricVelocityTool
Sets a parameter that will be used with the next invocation.
R
- read() - Method in class org.tinyjee.maven.dim.utils.CompositeInputStream
-
- read(byte[], int, int) - Method in class org.tinyjee.maven.dim.utils.CompositeInputStream
-
- readerToString(Reader, boolean) - Static method in class org.tinyjee.maven.dim.spi.UrlFetcher
- Utility method that converts the given text stream to a string.
- RegularExpressionSnippetSelector - Class in org.tinyjee.maven.dim.sources
- Implements a simple
regular expression
based snippet selector using the expression prefix "RE:". - RegularExpressionSnippetSelector() - Constructor for class org.tinyjee.maven.dim.sources.RegularExpressionSnippetSelector
- Constructs a new regular expression based snippet selector.
- RegularExpressionSnippetSelector(String) - Constructor for class org.tinyjee.maven.dim.sources.RegularExpressionSnippetSelector
-
- reInitializeGlobals(String, Sink, MacroRequest, Log, File) - Static method in class org.tinyjee.maven.dim.spi.Globals
-
- remove(String) - Method in class org.tinyjee.maven.dim.sources.AbstractParametricVelocityTool
- Removes a parameter form the internally maintained parameter list.
- remove() - Method in class org.tinyjee.maven.dim.sources.AbstractStreamingSnippetSelector.AbstractStreamIterator
-
- remove() - Method in class org.tinyjee.maven.dim.sources.AOPLikeSnippetSelector.LinesIterator
-
- remove() - Method in class org.tinyjee.maven.dim.utils.CompositeIterator
-
- removeLines(String, Collection<Integer>) - Method in class org.tinyjee.maven.dim.sh.CodeHighlighter
-
- RequestParameterTransformer - Interface in org.tinyjee.maven.dim.spi
RequestParameterTransformer
defines an interface that may be implemented and registered via service loading to plug parameter transformers that adjust macro parameters on the fly before any other operation is triggered.- reset() - Static method in class org.tinyjee.maven.dim.InitializeMacroMojo
- Resets any project specific adjustments that break path resolution when they remain active on a POM that did not call the this Mojo.
- reset() - Method in class org.tinyjee.maven.dim.sources.AbstractBufferedSource
-
- ResetMojo - Class in org.tinyjee.maven.dim
- Resets project specific paths that were previously set with 'initialize'.
- ResetMojo() - Constructor for class org.tinyjee.maven.dim.ResetMojo
-
- resolveBrushes() - Method in interface org.tinyjee.maven.dim.sh.BrushResolver
- Returns a list of URLs that point to ".JS" or ".ZIP" files containing additional brush definitions.
- resolveBrushes() - Method in class org.tinyjee.maven.dim.sh.BundledBrushesResolver
- Returns a list of URLs that point to ".JS" or ".ZIP" files containing additional brush definitions.
- resolveClass(String) - Method in class org.tinyjee.maven.dim.sources.VelocitySourceClassInvocationTool
- Resolves the given 'source-class' providing access to use reflection.
- resolveClass(File, String) - Static method in class org.tinyjee.maven.dim.spi.ResourceResolver
- Resolves the specified class.
- resolveClassLoader(File) - Static method in class org.tinyjee.maven.dim.spi.ResourceResolver
- Resolves a class loader for the given base path.
- resolveEntity(String, String) - Method in class org.tinyjee.maven.dim.utils.XhtmlEntityResolver
-
- resolveLocalPath(String) - Method in class org.tinyjee.maven.dim.spi.Globals
- Resolves the given local path and returns the corresponding file.
- resolvePath(String) - Method in class org.tinyjee.maven.dim.spi.Globals
- Resolves the given path to an URL that can be fetched via
UrlFetcher
. - ResourceResolver - Class in org.tinyjee.maven.dim.spi
- A collection of utility methods used to resolve resources.
- RESOURCES_FOLDER_NAME - Static variable in class org.tinyjee.maven.dim.IncludeMacro
- Specifies the folder name of the folder where resources are put.
- ROOT_ELEMENT_TAG_NAME - Static variable in class org.tinyjee.maven.dim.utils.PositioningJsonDocumentBuilder
-
S
- scanFieldsAndConstants(JavaClass) - Method in class org.tinyjee.maven.dim.extensions.JavaSourceLoader
- Scans all relevant fields and constants of the specified class and sets the results as map values.
- scanMethods(JavaClass) - Method in class org.tinyjee.maven.dim.extensions.JavaSourceLoader
- Scans all relevant methods of the specified class and sets the results as map values.
- scanProperties(JavaClass) - Method in class org.tinyjee.maven.dim.extensions.JavaSourceLoader
- Scans all relevant bean properties of the specified class and sets the results as map values.
- scope - Variable in class org.tinyjee.maven.dim.utils.JavaScriptFacade
-
- SCRIPT_ENCODING - Static variable in class org.tinyjee.maven.dim.utils.JavaScriptFacade
-
- ScriptExecutorJSR223 - Class in org.tinyjee.maven.dim.extensions
- Implements the JSR-223 bindings.
- ScriptExecutorJSR223() - Constructor for class org.tinyjee.maven.dim.extensions.ScriptExecutorJSR223
-
- ScriptInvoker - Class in org.tinyjee.maven.dim.extensions
- ScriptInvoker is a 'source-class' compatible helper class providing a runtime environment that allows to load and execute script code using the JSR-223 interface (scripting for java).
- ScriptInvoker(File, Map<String, Object>) - Constructor for class org.tinyjee.maven.dim.extensions.ScriptInvoker
- Constructs a new Script Invoker.
- ScriptInvoker.AliasHandler - Class in org.tinyjee.maven.dim.extensions
- Implements the "
ScriptInvoker.PARAM_ALIAS
" alias functionality. - ScriptInvoker.AliasHandler() - Constructor for class org.tinyjee.maven.dim.extensions.ScriptInvoker.AliasHandler
- Constructs the handler (Note: Is called by
RequestParameterTransformer.TRANSFORMERS
). - select(SelectableArrayList.Selector<E>) - Method in class org.tinyjee.maven.dim.utils.SelectableArrayList
- Selects a sub list of all elements that were matched by the given selector.
- SelectableArrayList<E> - Class in org.tinyjee.maven.dim.utils
- Implements an array list that allows sub-list selections via regular expressions and / or selectors.
- SelectableArrayList() - Constructor for class org.tinyjee.maven.dim.utils.SelectableArrayList
-
- SelectableArrayList(int) - Constructor for class org.tinyjee.maven.dim.utils.SelectableArrayList
-
- SelectableArrayList(Collection<? extends E>) - Constructor for class org.tinyjee.maven.dim.utils.SelectableArrayList
-
- SelectableArrayList.Selector<E> - Interface in org.tinyjee.maven.dim.utils
- Defines a selector to be used when selecting a sub-list.
- SelectableJavaEntitiesList<E extends AbstractJavaEntity> - Class in org.tinyjee.maven.dim.utils
- Implements AbstractSelectableJavaEntitiesList for elements that directly derive from
AbstractJavaEntity
. - SelectableJavaEntitiesList() - Constructor for class org.tinyjee.maven.dim.utils.SelectableJavaEntitiesList
-
- SelectableJavaEntitiesList(Collection<? extends E>) - Constructor for class org.tinyjee.maven.dim.utils.SelectableJavaEntitiesList
-
- SelectableMappedJavaEntitiesList - Class in org.tinyjee.maven.dim.extensions
- Implements
AbstractSelectableJavaEntitiesList
to let it host output from JavaSourceLoader
. - SelectableMappedJavaEntitiesList(Collection<? extends Map<?, ?>>, String) - Constructor for class org.tinyjee.maven.dim.extensions.SelectableMappedJavaEntitiesList
-
- SelectableMappedJavaEntitiesList(String) - Constructor for class org.tinyjee.maven.dim.extensions.SelectableMappedJavaEntitiesList
-
- selectAnnotated(String) - Method in class org.tinyjee.maven.dim.utils.AbstractSelectableJavaEntitiesList
- Selects all java entities that are annotated with an annotation that is matching the given AOP-like expression.
- selectBeanProperty(AbstractJavaEntity, Set<Integer>) - Method in class org.tinyjee.maven.dim.sources.AOPLikeSnippetSelector.LinesIterator
-
- selectCommentAbove(int, Set<Integer>) - Method in class org.tinyjee.maven.dim.sources.AOPLikeSnippetSelector.LinesIterator
-
- selectDerived(String) - Method in class org.tinyjee.maven.dim.utils.AbstractSelectableJavaEntitiesList
- Selects all java entities that derive from a class that is matching the given AOP-like expression.
- selectLines(AbstractJavaEntity, Set<Integer>) - Method in class org.tinyjee.maven.dim.sources.AOPLikeSnippetSelector.LinesIterator
-
- selectMatching(String) - Method in class org.tinyjee.maven.dim.utils.AbstractSelectableJavaEntitiesList
- Selects all java entities that match the given AOP-like expression.
- selectMatching(String) - Method in class org.tinyjee.maven.dim.utils.SelectableArrayList
- Selects all elements whose string representation matches the given regular expression.
- selectMatching(String...) - Method in class org.tinyjee.maven.dim.utils.SelectableArrayList
- Selects all elements whose string representation matches the one of given regular expressions.
- selectNonAnnotated(String) - Method in class org.tinyjee.maven.dim.utils.AbstractSelectableJavaEntitiesList
- Selects all java entities that are not annotated with an annotation that is matching the given AOP-like expression.
- selectNonDerived(String) - Method in class org.tinyjee.maven.dim.utils.AbstractSelectableJavaEntitiesList
- Selects all java entities that do not derive from a class that is matching the given AOP-like expression.
- selectNonMatching(String) - Method in class org.tinyjee.maven.dim.utils.AbstractSelectableJavaEntitiesList
- Selects all java entities that do not match the given AOP-like expression.
- selectNonMatching(String) - Method in class org.tinyjee.maven.dim.utils.SelectableArrayList
- Selects all elements whose string representation does NOT match the given regular expression.
- SELECTORS - Static variable in interface org.tinyjee.maven.dim.spi.SnippetSelector
- Is an iterable over all selectors within the classpath.
- selectSnippets(String, URL, LineNumberReader, Map<String, Object>) - Method in class org.tinyjee.maven.dim.sources.AOPLikeSnippetSelector
-
- selectSnippets(String, URL, LineNumberReader, Map<String, Object>) - Method in class org.tinyjee.maven.dim.sources.GrepLikeSnippetSelector
-
- selectSnippets(String, URL, LineNumberReader, Map<String, Object>) - Method in class org.tinyjee.maven.dim.sources.IdDefinitionSelector
-
- selectSnippets(String, URL, LineNumberReader, Map<String, Object>) - Method in class org.tinyjee.maven.dim.sources.IdSnippetSelector
-
- selectSnippets(String, URL, LineNumberReader, Map<String, Object>) - Method in class org.tinyjee.maven.dim.sources.LineRangeSnippetSelector
-
- selectSnippets(String, URL, LineNumberReader, Map<String, Object>) - Method in class org.tinyjee.maven.dim.sources.RegularExpressionSnippetSelector
-
- selectSnippets(String, URL, LineNumberReader, Map<String, Object>) - Method in class org.tinyjee.maven.dim.sources.TokenAndBraceSnippetSelector
-
- selectSnippets(String, URL, LineNumberReader, Map<String, Object>) - Method in class org.tinyjee.maven.dim.sources.XPathSnippetSelector
-
- selectSnippets(Source) - Method in class org.tinyjee.maven.dim.spi.SnippetExtractor
- Selects the snippets of the given source.
- selectSnippets(String, URL, LineNumberReader, Map<String, Object>) - Method in interface org.tinyjee.maven.dim.spi.SnippetSelector
- Selects snippets in the given content and returns an iterator over selected line numbers.
- serialize(E, boolean) - Method in class org.tinyjee.maven.dim.utils.JaxbXmlSerializer
- Serializes the given instance and returns a DOM document of the serialized content.
- serialize(Node) - Method in interface org.tinyjee.maven.dim.utils.XPathEvaluator
- Serializes the given DOM node to XML.
- serialize(Node) - Method in class org.tinyjee.maven.dim.utils.XPathEvaluatorImplementation
-
- serializeNode(Node, boolean, boolean) - Static method in class org.tinyjee.maven.dim.utils.XPathEvaluatorImplementation
-
- ServiceLoader - Class in org.tinyjee.maven.dim.spi.backport
- Minimum efforts backport of ServiceLoader found in Java 1.6 to be used in Java 1.5.
- SetBaseDirPropertyMojo - Class in org.tinyjee.maven.dim
- Deprecated. Use goal "initialize" instead.
- SetBaseDirPropertyMojo() - Constructor for class org.tinyjee.maven.dim.SetBaseDirPropertyMojo
- Deprecated.
- setModulePath(String, String, File) - Static method in class org.tinyjee.maven.dim.spi.ResourceResolver
- Sets additional search paths that are used to support source definitions like '[artifactId]:/some-path' or '[groupId:artifactId]:/some-path'.
- size() - Method in class org.tinyjee.maven.dim.utils.NodeListAdapter
-
- SnippetExtractor - Class in org.tinyjee.maven.dim.spi
- Implements a singleton that uses snippet selectors and sources to extract portions of content and format it as a map of selected lines, indexed by their starting line numbers.
- SnippetSelector - Interface in org.tinyjee.maven.dim.spi
SnippetSelector
defines an interface that may be implemented and registered via service loading to add new snippet selection mechanisms.- Source - Interface in org.tinyjee.maven.dim.spi
- Defines an abstract interface for sources that may be a mixture of source content (multiple snippets) and assigned meta data (parameters).
- Source.Content - Interface in org.tinyjee.maven.dim.spi
- Defines actual source content.
- SourceClassAdapter - Class in org.tinyjee.maven.dim.sources
- Adapts a source class to the source interface.
- SourceClassAdapter(File, Map, String) - Constructor for class org.tinyjee.maven.dim.sources.SourceClassAdapter
- Creates a new instance of SourceClassAdapter.
- sourceUrl - Variable in class org.tinyjee.maven.dim.spi.AbstractSource
-
- splitExpression(String) - Method in class org.tinyjee.maven.dim.spi.SnippetExtractor
- Splits a given snippet expression into the individual sub-expression parts.
- stripPrefix(String) - Method in class org.tinyjee.maven.dim.sources.AbstractSnippetSelector
- Strips the prefix form the given snippet selection expression.
- StyleHandler - Class in org.tinyjee.maven.dim.sh
- Handles the inclusion of styles.
- StyleHandler() - Constructor for class org.tinyjee.maven.dim.sh.StyleHandler
- Constructs a new style handler with the default style theme.
- StyleHandler(String) - Constructor for class org.tinyjee.maven.dim.sh.StyleHandler
- Constructs a new style handler with the given style theme.
- SvgLoader - Class in org.tinyjee.maven.dim.extensions
- SvgLoader is a 'source-class' compatible helper class that can load and transform SVG content and include it either directly or rendered as PNG.
- SvgLoader(File, Map<String, Object>) - Constructor for class org.tinyjee.maven.dim.extensions.SvgLoader
-
- SvgLoader.AliasHandler - Class in org.tinyjee.maven.dim.extensions
- Implements the "
SvgLoader.PARAM_ALIAS
" alias functionality. - SvgLoader.AliasHandler() - Constructor for class org.tinyjee.maven.dim.extensions.SvgLoader.AliasHandler
- Constructs the handler (Note: Is called by
RequestParameterTransformer.TRANSFORMERS
).
T
- TabbedPanelParameterTransformer - Class in org.tinyjee.maven.dim.extensions
- This extension renders a tabbed panel from document sections (hierarchical headlines in Doxia).
- TabbedPanelParameterTransformer() - Constructor for class org.tinyjee.maven.dim.extensions.TabbedPanelParameterTransformer
-
- TableLayoutParameterTransformer - Class in org.tinyjee.maven.dim.extensions
- This extension re-arranges selected document sections (hierarchical headlines in Doxia) using a table of columns and rows.
- TableLayoutParameterTransformer() - Constructor for class org.tinyjee.maven.dim.extensions.TableLayoutParameterTransformer
-
- TemplateSource - Class in org.tinyjee.maven.dim.sources
- Wraps a source content that contains a velocity template and executes it on using the Source interfaces.
- TemplateSource(URL, Source) - Constructor for class org.tinyjee.maven.dim.sources.TemplateSource
- Constructs a new TemplateSource.
- TemplateSource.UrlResourceLoader - Class in org.tinyjee.maven.dim.sources
- Resolves templates from Urls.
- TemplateSource.UrlResourceLoader() - Constructor for class org.tinyjee.maven.dim.sources.TemplateSource.UrlResourceLoader
-
- toFilePath(String) - Static method in class org.tinyjee.maven.dim.spi.ResourceResolver
- Converts the given source to a filePath if possible.
- TokenAndBraceSnippetSelector - Class in org.tinyjee.maven.dim.sources
- Selects snippets using an activation token and open/close brace counting, using the expression prefix "TB:".
- TokenAndBraceSnippetSelector() - Constructor for class org.tinyjee.maven.dim.sources.TokenAndBraceSnippetSelector
-
- TokenAndBraceSnippetSelector(String) - Constructor for class org.tinyjee.maven.dim.sources.TokenAndBraceSnippetSelector
-
- toString() - Method in class org.tinyjee.maven.dim.extensions.JavaDocTagsHandler
-
- toString() - Method in class org.tinyjee.maven.dim.sources.AbstractBufferedSource.BufferedSourceContent
-
- toString() - Method in class org.tinyjee.maven.dim.sources.AbstractParametricVelocityTool
-
- toString() - Method in class org.tinyjee.maven.dim.sources.AbstractSnippetSelector
-
- toString() - Method in class org.tinyjee.maven.dim.sources.AbstractStreamingSnippetSelector.AbstractStreamIterator
-
- toString() - Method in class org.tinyjee.maven.dim.spi.AbstractSource.SourceContent
-
- toString() - Method in class org.tinyjee.maven.dim.spi.AbstractSource
-
- toString() - Method in class org.tinyjee.maven.dim.spi.Globals
-
- toString(Map<Integer, List<String>>, boolean) - Method in class org.tinyjee.maven.dim.spi.SnippetExtractor
- Flattens the given content to pure text using system specific line breaks.
- toString(List<String>) - Method in class org.tinyjee.maven.dim.spi.SnippetExtractor
- Flattens the given lines to pure text using system specific line breaks.
- toString(List<String>, StringBuilder) - Method in class org.tinyjee.maven.dim.spi.SnippetExtractor
- Flattens the given lines to pure text using system specific line breaks.
- toString() - Method in class org.tinyjee.maven.dim.utils.CompositeIterator
-
- TRANSFORMERS - Static variable in interface org.tinyjee.maven.dim.spi.RequestParameterTransformer
- Is an iterable over all transformers within the classpath.
- transformParameters(Map<String, Object>) - Method in class org.tinyjee.maven.dim.extensions.AbstractParameterTransformer
-
- transformParameters(Map<String, Object>) - Method in class org.tinyjee.maven.dim.extensions.MessageBoxParameterTransformer
-
- transformParameters(Map<String, Object>) - Method in class org.tinyjee.maven.dim.MacroPresetParameterTransformer
-
- transformParameters(Map<String, Object>) - Method in interface org.tinyjee.maven.dim.spi.RequestParameterTransformer
- Transforms the specified request parameters.
- transformParameters(Map<String, Object>) - Method in class org.tinyjee.maven.dim.utils.AbstractAliasHandler
- Transforms the specified request parameters.
- transformParameters(Map<String, Object>) - Method in class org.tinyjee.maven.dim.utils.InterfaceScanner.AliasHandler
- Deprecated.
- typeToString(Type) - Static method in class org.tinyjee.maven.dim.extensions.JavaSourceLoader
- Converts the given type to string.
U
- unIndent(SortedMap<Integer, List<String>>, boolean) - Method in class org.tinyjee.maven.dim.spi.SnippetExtractor
- Removes unnecessary indents.
- UNKNOWN - Static variable in class org.tinyjee.maven.dim.spi.FixedContentSource
- Defines an unknown url that may be used as substitution for 'null' in services that are not null-pointer safe.
- unwrap(Map<?, ?>) - Method in class org.tinyjee.maven.dim.extensions.SelectableMappedJavaEntitiesList
-
- unwrap(E) - Method in class org.tinyjee.maven.dim.utils.AbstractSelectableJavaEntitiesList
- Unwraps the given list element to something that can be converted to a valid
AbstractJavaEntity
inside AbstractSelectableJavaEntitiesList.unwrapToEntity(Object)
. - unwrap(E) - Method in class org.tinyjee.maven.dim.utils.SelectableJavaEntitiesList
-
- unwrapToEntity(E) - Method in class org.tinyjee.maven.dim.utils.AbstractSelectableJavaEntitiesList
- Converts the given list element to
AbstractJavaEntity
. - UrlFetcher - Class in org.tinyjee.maven.dim.spi
- Abstracts url fetching, charset handling and caching.
- UrlSource - Class in org.tinyjee.maven.dim.sources
- Wraps the logic of translating a source URL to the Source interface.
- UrlSource(URL, Map<String, Object>) - Constructor for class org.tinyjee.maven.dim.sources.UrlSource
-
V
- VELOCITY_TEMPLATE_EXTENSION - Static variable in class org.tinyjee.maven.dim.IncludeMacro
- Specifies the extension used to detect velocity templates.
- VelocityConfigurator - Interface in org.tinyjee.maven.dim.spi
VelocityConfigurator
defines an interface that may be implemented and registered via service loading to customize the configuration of the velocity template engine and context before the templates are rendered.- VelocityHighlightingTool - Class in org.tinyjee.maven.dim.sources
- Implements a custom velocity tool that can be used to trigger code highlighting within templates.
- VelocityHighlightingTool() - Constructor for class org.tinyjee.maven.dim.sources.VelocityHighlightingTool
-
- VelocitySourceClassInvocationTool - Class in org.tinyjee.maven.dim.sources
- Implements a custom velocity tool that can be used to invoke other source classes.
- VelocitySourceClassInvocationTool() - Constructor for class org.tinyjee.maven.dim.sources.VelocitySourceClassInvocationTool
-
W
- writeSourceContent(Writer) - Method in class org.tinyjee.maven.dim.sources.AbstractBufferedSource
- Is called when the source content has to be created.
- writeSourceContent(Writer) - Method in class org.tinyjee.maven.dim.sources.SourceClassAdapter
-
- writeSourceContent(Writer) - Method in class org.tinyjee.maven.dim.sources.TemplateSource
-
X
- XhtmlEntityResolver - Class in org.tinyjee.maven.dim.utils
- This is a simple DTD resolver that attempts to load DTDs from the classpath first before delegating to a web query.
- XhtmlEntityResolver() - Constructor for class org.tinyjee.maven.dim.utils.XhtmlEntityResolver
-
- xml(String) - Method in class org.tinyjee.maven.dim.sources.VelocityHighlightingTool
- Shortcut to
highlight("xml", code)
. - XmlLoader - Class in org.tinyjee.maven.dim.extensions
- XmlLoader is a 'source-class' compatible helper class that can load and transform XML/JSON content and provide XPath and DOM oriented access to the document elements when used in combination with a velocity template.
- XmlLoader(File, Map<String, Object>) - Constructor for class org.tinyjee.maven.dim.extensions.XmlLoader
- Constructs a new XML loader.
- XmlLoader.AliasHandler - Class in org.tinyjee.maven.dim.extensions
- Implements the "
XmlLoader.PARAM_ALIAS
" alias functionality. - XmlLoader.AliasHandler() - Constructor for class org.tinyjee.maven.dim.extensions.XmlLoader.AliasHandler
- Constructs the handler (Note: Is called by
RequestParameterTransformer.TRANSFORMERS
). - XPathEvaluator - Interface in org.tinyjee.maven.dim.utils
- Defines a simple data access interface that may be used to evaluate XPath expressions against the loaded XML document.
- XPathEvaluatorImplementation - Class in org.tinyjee.maven.dim.utils
- Implements
XPathEvaluator
. - XPathEvaluatorImplementation(Document) - Constructor for class org.tinyjee.maven.dim.utils.XPathEvaluatorImplementation
- Creates a new evaluator around the given document.
- XPathSnippetSelector - Class in org.tinyjee.maven.dim.sources
- Implements a XPath expression based snippet selector supporting XML and JSON formatted input, using the expression prefix "XP:".
- XPathSnippetSelector() - Constructor for class org.tinyjee.maven.dim.sources.XPathSnippetSelector
-
- XPathSnippetSelector(String) - Constructor for class org.tinyjee.maven.dim.sources.XPathSnippetSelector
-
A B C D E F G H I J K L M N O P R S T U V W X Overview Package Class Use Tree Deprecated Index Help
PREV NEXT FRAMES NO FRAMES All Classes