Package org.jgroups.util

Class PropertiesToAsciidoc

java.lang.Object

org.jgroups.util.PropertiesToAsciidoc

public class PropertiesToAsciidoc
extends Object

Iterates over all concrete Protocol classes and creates tables with Protocol's properties. These tables are in turn then merged into asciidoc. Iterates over unsupported and experimental classes and creates tables listing those classes. These tables are in turn then merged into asciidoc.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	ROOT_PACKAGE

Constructor Summary

Constructors

Constructor	Description
PropertiesToAsciidoc()

Method Summary

Modifier and Type	Method	Description
private static void	convertClassToAsciidocTable(Properties props, Class<?> clazz, String prefix)
protected static void	convertUnsupportedToAsciidocTable(Properties props, List<Class<?>> clazzes, String title)
static int	copy(Reader input, Writer output)
protected static String	createAsciidocTable(List<String[]> rows, String title, String header)	Creates an AsciiDoc table of the elements in rows.
private static String	fileToString(File f)
protected static void	getDescriptions(Class<?> clazz, Map<String,String> m, String prefix, boolean print_class)
(package private) static void	help()
static void	main(String[] args)
protected static String	readUntilBracket(InputStream in)	Reads until the next bracket '}' and returns the string excluding the bracket, or throws an exception if no bracket has been found
protected static void	replaceVariables(InputStream in, OutputStream out, Properties p)	Reads from the input stream and replaces occurrences of ${PROT} with p.get("PROT") and writes this to the output stream.
protected static void	writeVarToStream(String var, Properties p, OutputStream out)

Methods inherited from class java.lang.Object

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

Field Details

ROOT_PACKAGE

protected static final String ROOT_PACKAGE

See Also:

• Constant Field Values

Constructor Details

PropertiesToAsciidoc

public PropertiesToAsciidoc()

Method Details

main

public static void main(String[] args)

help

static void help()

convertUnsupportedToAsciidocTable

protected static void convertUnsupportedToAsciidocTable(Properties props,
 List<Class<?>> clazzes,
 String title)
                                                 throws ParserConfigurationException,
TransformerException

Throws:

ParserConfigurationException

TransformerException

createAsciidocTable

protected static String createAsciidocTable(List<String[]> rows,
 String title,
 String header)
                                     throws ParserConfigurationException,
TransformerException

Creates an AsciiDoc table of the elements in rows. The first tuple needs to be the column names, the rest the contents

Throws:

ParserConfigurationException

TransformerException

convertClassToAsciidocTable

private static void convertClassToAsciidocTable(Properties props,
 Class<?> clazz,
 String prefix)
                                         throws Exception

Throws:

Exception

getDescriptions

protected static void getDescriptions(Class<?> clazz,
 Map<String,String> m,
 String prefix,
 boolean print_class)
                               throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

replaceVariables

protected static void replaceVariables(InputStream in,
 OutputStream out,
 Properties p)

Reads from the input stream and replaces occurrences of ${PROT} with p.get("PROT") and writes this to the output stream. If no value is found, then the ${PROT} will simple be omitted from the output. Escaped values of the form \${PROT} are not looked up and the value without the backslash will be written to the output stream.

writeVarToStream

protected static void writeVarToStream(String var,
 Properties p,
 OutputStream out)
                                throws IOException

Throws:

IOException

readUntilBracket

protected static String readUntilBracket(InputStream in)
                                  throws IOException

Reads until the next bracket '}' and returns the string excluding the bracket, or throws an exception if no bracket has been found

Throws:

IOException

fileToString

private static String fileToString(File f)
                            throws Exception

Throws:

Exception

copy

public static int copy(Reader input,
 Writer output)
                throws IOException

Throws:

IOException