dochelper.TransformDefinition Interface Reference
The interfaceRenderDefinition defines how classes that are going to be utilized to Render DocPattern matches should behave.
More...
Public Member Functions | |
| String | render (MatchResult result) |
| Main method of RenderDefinition interface. | |
| String | getText () |
| Retrieves the String template that will be used to render the matches. | |
Detailed Description
The interfaceRenderDefinition defines how classes that are going to be utilized to Render DocPattern matches should behave.
Definition at line 21 of file TransformDefinition.java.
Member Function Documentation
| String dochelper.TransformDefinition.render | ( | MatchResult | result | ) |
Main method of RenderDefinition interface.
This method is called for all RenderDefinitions to create the output content given a set of matches for a particular regular expression.
Once a DocPattern is executed, if it finds a set of matches (within the contents of the record) it will call the RenderDefinition associated with it, to render the matches.
- Parameters:
-
result java.util.regex.MatchResult that contains the match results for a regular expression. It contains the whole match and separate groups.
- Returns:
- String containing the render result.
Implemented in dochelper.DocPattern, dochelper.EscapedMatchTransformDefinition, dochelper.FileTransformDefinition, dochelper.TransformDefinitionImpl, and dochelper.xins.XINSCAPIPatternTransform.
| String dochelper.TransformDefinition.getText | ( | ) |
Retrieves the String template that will be used to render the matches.
- Returns:
- String containing template to be used to render matches.
Implemented in dochelper.DocPattern, dochelper.EscapedMatchTransformDefinition, dochelper.FileTransformDefinition, and dochelper.TransformDefinitionImpl.
The documentation for this interface was generated from the following file:
- src/dochelper/TransformDefinition.java
