org.onosproject.yangutils.utils.io.impl

Class JavaDocGen

java.lang.Object

org.onosproject.yangutils.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	generateForAddAugmentation() Generates javaDocs for add augmentation method.
static String	generateForBuilderMethod(String attribute) Generates for builder method.
static String	generateForGetAugmentation() Returns javadoc for get augmentation method.
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, YangPluginConfig pluginConfig) Generates javaDocs for rpc method.
static String	getJavaDoc(JavaDocGen.JavaDocType type, String name, boolean isList, YangPluginConfig pluginConfig, String compilerAnnotation) Returns java docs.

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,
                                YangPluginConfig pluginConfig,
                                String compilerAnnotation)

Returns java docs.

Parameters:

type - java doc type

name - name of the YangNode

isList - is list attribute

pluginConfig - plugin configurations

compilerAnnotation - compiler annotations for user defined data type

Returns:

javadocs.

generateJavaDocForRpc

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

Generates javaDocs for rpc method.

Parameters:

rpcName - name of the rpc

inputName - name of input

outputName - name of output

pluginConfig - plugin configurations

Returns:

javaDocs of rpc method

generateForAddAugmentation

public static String generateForAddAugmentation()

Generates javaDocs for add augmentation method.

Returns:

javaDocs

generateForGetAugmentation

public static String generateForGetAugmentation()

Returns javadoc for get augmentation method.

Returns:

javadoc for get augmentation 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

generateForBuilderMethod

public static String generateForBuilderMethod(String attribute)

Generates for builder method.

Parameters:

attribute - attribute

Returns:

javaDocs