org.onosproject.yang.compiler.utils.io.impl

Class JavaDocGen

java.lang.Object

org.onosproject.yang.compiler.utils.io.impl.JavaDocGen

public final class JavaDocGen
extends Object

Represents javadoc for the generated classes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JavaDocGen.JavaDocType JavaDocs types.

Method Summary

Modifier and Type	Method and Description
static String	enumJavaDocForInnerClass(String name) Generates javaDocs for inner class enum's attributes.
static String	generateForGetMethodWithAttribute(String attribute) Generates javaDocs for type constructor.
static String	generateForValidatorMethod() Returns javadoc for validator method.
static String	generateJavaDocForRpc(String rpcName, String inputName, String outputName) Generates javaDocs for rpc method.
static String	getJavaDoc(JavaDocGen.JavaDocType type, String name, boolean isList, String compilerAnnotation) Returns java docs.
static String	getJavaDocForExecuteMethod() Returns javadoc for execute method.
static String	getJavaDocForExtendedExecuteMethod() Returns javadoc for RPC extended command execute method.
static String	getJavadocForRegisterRpcConstructor() Returns javadoc for register RPC constructor.
static String	getJavaDocForRpcCommandConstructor(String rpcName) Returns javadoc for RPC command constructor.
static String	getJavaDocForRpcExecuterConstructor() Returns javadoc for RPC executer constructor.
static String	getJavaDocForRpcExtendedCommandConstructor() Returns javadoc for RPC extended command constructor.
static String	getJavaDocWithoutParam(String data, String space) Returns data in javadoc format.

Methods inherited from class java.lang.Object

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

Method Detail

getJavaDoc

public static String getJavaDoc(JavaDocGen.JavaDocType type,
                                String name,
                                boolean isList,
                                String compilerAnnotation)

Returns java docs.

Parameters:

type - java doc type

name - name of the YangNode

isList - is list attribute

compilerAnnotation - compiler annotations for user defined data type

Returns:

javaDocs.

enumJavaDocForInnerClass

public static String enumJavaDocForInnerClass(String name)

Generates javaDocs for inner class enum's attributes.

Parameters:

name - attribute name

Returns:

javaDocs

generateJavaDocForRpc

public static String generateJavaDocForRpc(String rpcName,
                                           String inputName,
                                           String outputName)

Generates javaDocs for rpc method.

Parameters:

rpcName - name of the rpc

inputName - name of input

outputName - name of output

Returns:

javaDocs of rpc method

generateForValidatorMethod

public static String generateForValidatorMethod()

Returns javadoc for validator method.

Returns:

javadoc for validator method

generateForGetMethodWithAttribute

public static String generateForGetMethodWithAttribute(String attribute)

Generates javaDocs for type constructor.

Parameters:

attribute - attribute string

Returns:

javaDocs for type constructor

getJavaDocWithoutParam

public static String getJavaDocWithoutParam(String data,
                                            String space)

Returns data in javadoc format.

Parameters:

data - content of javadoc

space - indendation for javadoc

Returns:

data in javadoc format

getJavaDocForRpcExecuterConstructor

public static String getJavaDocForRpcExecuterConstructor()

Returns javadoc for RPC executer constructor.

Returns:

javadoc for RPC executer constructor

getJavaDocForRpcCommandConstructor

public static String getJavaDocForRpcCommandConstructor(String rpcName)

Returns javadoc for RPC command constructor.

Parameters:

rpcName - name of RPC

Returns:

javadoc for RPC command constructor

getJavaDocForRpcExtendedCommandConstructor

public static String getJavaDocForRpcExtendedCommandConstructor()

Returns javadoc for RPC extended command constructor.

Returns:

javadoc for RPC extended command constructor

getJavaDocForExtendedExecuteMethod

public static String getJavaDocForExtendedExecuteMethod()

Returns javadoc for RPC extended command execute method.

Returns:

javadoc for RPC extended command execute method

getJavaDocForExecuteMethod

public static String getJavaDocForExecuteMethod()

Returns javadoc for execute method.

Returns:

javadoc for execute method

getJavadocForRegisterRpcConstructor

public static String getJavadocForRegisterRpcConstructor()

Returns javadoc for register RPC constructor.

Returns:

javadoc for register RPC constructor