- Functional Interface:
- This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface public interface HiLiter
HiLiter - Documentation.
This interface can be replaced if there are other HiLiter's that seem compatible with this JavaDoc Upgrade Tool. All that is expected is that whatever mechanism is used - it needs to be able to convert Source-Code into HTML given the inputs below.
Implementations of this
Functional Interfaceshould be expected to receive Source-Code in many formats, along with a
'Code Type'that identifies what language is included in the Source-Code File. A
'Style Type'may also provided (if needed), but only two styles are used, internally, by the
HiLiteritself - one for "Complete File" Source-Code
String's, and one for "Snippet."
HiLiteris the one in the
HiLiteMe. This class is capable of providing a
'Cache'to avoid making internet-connections for code that has already been hilited and hasn't changed. Any subsequent / alternate implementations inserted into this JavaDoc Upgrader do not need to provide a
Cache, but if HTTP Connections are utilized, it is of tremendous benefit.
java.util.Vector<HTMLNode> hiLite(java.lang.String code, java.lang.String codeType, boolean snippetOrComplete) throws java.io.IOException, HiLiteExceptionThis
Functional Interfaceexpects this method to be implemented. Any HiLiter that would be "plugged into" this Documentation Tool must be able to Pretty-Print HiLite input Source-Code (passed as a
java.lang.String) and return HTML.
NOTE: Any Code HiLiter that can operate with this input may be plugged in here. In order to "Vectorize" HTML, just use the
code- This is the Source-Code as a
codeType- This is a short descriptor of what kind of code is being passed. The most frequent values for this parameter are:
'java', 'html', 'js'etc...
snippetOrComplete- This is a
TRUE, indicates that a code-snippet has been passed, and when
FALSEindicates that a complete source code file has been passed.
- The intention is to return a Vectorized-HTML page (or sub-page) that contains a HiLited & Pretty-Printed version of the source-code.
java.io.IOException- This method is not defined, but it is permitted to throw
IOException- if there have been I/O problems when attempting to transform the source-code.
HiLiteException- This exception may be used if other problems occur during the transformation process.
static HiLiter getDefault(HiLiteMe.Cache c, java.lang.String snippetStyleCode, java.lang.String completeStyleCode)The Default Code HiLiter uses the class
HiLiteMe. This method is invoked by the
Upgradeclass and used to HiLite BOTH code-snippets AND complete source-code files.
c- This is the Server-Cache that may or may not be used. If this parameter is passed
'null', it will be ignored.
snippetStyleCode- Some of the source-code passed to this
HiLiterwill be short code-snippets, while other passed values of source-code will be complete source-code files. This
'Style Parameter'used for code-snippets.
completeStyleCode- When the
HiLiteris asked to Hi-Lite and entire source code file, this parameter will be used for a
'Style Parameter'with the
- An instance of
HiLiterthat can be used by the
- See Also:
HiLiteMe.prettyPrintScrapeToVectorAndSimplify(String, String, String),
HiLiteMe.prettyPrintScrapeToVectorAndSimplify(String, String, String, HiLiteMe.Cache)
- Exact Method Body: