org.kurento.modulecreator.codegen.function

Class SphinxLinks

java.lang.Object

org.kurento.modulecreator.codegen.function.SphinxLinks

All Implemented Interfaces:

freemarker.template.TemplateMethodModel, freemarker.template.TemplateMethodModelEx, freemarker.template.TemplateModel

public class SphinxLinks
extends Object
implements freemarker.template.TemplateMethodModelEx

Replace sphinx/restructured text roles by javadoc and jsdoc equivalents in Kurento kmd.json documentation

Author:

Santiago Gala (sgala@apache.org), Jesús Leganés-Combarro 'piranna' (piranna@gmail.com)

Field Summary

Fields inherited from interface freemarker.template.TemplateModel

NOTHING

Constructor Summary

Constructors

Constructor and Description
SphinxLinks(ModuleDefinition module)

Method Summary

Methods

Modifier and Type	Method and Description
Object	exec(List arguments) Takes a string and replaces occurrences of rst/sphinx with kurento domain markup with javadoc and jsdoc equivalents.
String	make_id(String txt) Our use case is $ python -c "from docutils import nodes; print('term-'+nodes.make_id('QR'))" , which returns term-qr i.e., identifiers conforming to the regular expression [a-z](-?[a-z0-9]+)*
String	translate(String text, List<String[]> patterns) Clone the python unicode translate method in legacy languages younger than python.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SphinxLinks

public SphinxLinks(ModuleDefinition module)

Method Detail

exec

public Object exec(List arguments)
            throws freemarker.template.TemplateModelException

Takes a string and replaces occurrences of rst/sphinx with kurento domain markup with javadoc and jsdoc equivalents.

Specified by:

exec in interface freemarker.template.TemplateMethodModel

Specified by:

exec in interface freemarker.template.TemplateMethodModelEx

Parameters:

arguments - A list of arguments as Strings from the call. The first one is the rst/sphinx text, and the second optional one defines the current class full name.

Throws:

freemarker.template.TemplateModelException

See Also:

TemplateMethodModelEx.exec(java.util.List)

translate

public String translate(String text,
               List<String[]> patterns)

Clone the python unicode translate method in legacy languages younger than python. python docutils is public domain.

Parameters:

text - string for which translation is needed

patterns - Array of arrays {target, replacement). The target is substituted by the replacement.

Returns:

The translated string

See Also:

http://docs.python.org/3/library/stdtypes.html#str.translate

make_id

public String make_id(String txt)

Our use case is $ python -c "from docutils import nodes; print('term-'+nodes.make_id('QR'))" , which returns term-qr i.e., identifiers conforming to the regular expression [a-z](-?[a-z0-9]+)*

But there is a requirement to use pure java for this task. So we clone the function here. python docutils is public domain.

See Also:

://code.nabla.net/doc/docutils/api/docutils/nodes/docutils.nodes. make_id.html