org.opendaylight.mdsal.binding.javav2.generator.impl.util

Class YangTextTemplate

java.lang.Object

org.opendaylight.mdsal.binding.javav2.generator.impl.util.YangTextTemplate

@Beta
public final class YangTextTemplate
extends Object

Util class

Method Summary

Modifier and Type	Method and Description
static String	encodeJavadocSymbols(String description)
static String	formatSchemaPath(String moduleName, Iterable<org.opendaylight.yangtools.yang.common.QName> schemaPath)
static String	formatToAugmentPath(Iterable<org.opendaylight.yangtools.yang.common.QName> schemaPath) Used in all yangtemplates for formating augmentation target
static String	formatToParagraph(String text, int nextLineIndent) Used in #yangtemplateformodule.scala.txt for formating revision description
static String	getExplicitType(GeneratedType parentGenType, Type type, Map<String,String> imports) Builds the string which contains either the full path to the type (package name with type) or only type name if the package is among imports.
static void	putTypeIntoImports(GeneratedType parentGenType, Type type, Map<String,String> imports) Evaluates if it is necessary to add the package name for type to the map of imports for parentGenType If it is so the package name is saved to the map imports.
static String	wrapToDocumentation(String text) Wraps text as documentation

Methods inherited from class java.lang.Object

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

Method Detail

formatSchemaPath

public static String formatSchemaPath(String moduleName,
                                      Iterable<org.opendaylight.yangtools.yang.common.QName> schemaPath)

formatToParagraph

public static String formatToParagraph(String text,
                                       int nextLineIndent)

Used in #yangtemplateformodule.scala.txt for formating revision description

Parameters:

text - Content of tag description

nextLineIndent - Number of spaces from left side default is 12

Returns:

formatted description

formatToAugmentPath

public static String formatToAugmentPath(Iterable<org.opendaylight.yangtools.yang.common.QName> schemaPath)

Used in all yangtemplates for formating augmentation target

Parameters:

schemaPath - path to augmented node

Returns:

path in string format

putTypeIntoImports

public static void putTypeIntoImports(GeneratedType parentGenType,
                                      Type type,
                                      Map<String,String> imports)

Evaluates if it is necessary to add the package name for type to the map of imports for parentGenType If it is so the package name is saved to the map imports.

Parameters:

parentGenType - generated type for which is the map of necessary imports build

type - JAVA type for which is the necessary of the package import evaluated

imports - map of the imports for parentGenType

getExplicitType

public static String getExplicitType(GeneratedType parentGenType,
                                     Type type,
                                     Map<String,String> imports)

Builds the string which contains either the full path to the type (package name with type) or only type name if the package is among imports.

Parameters:

parentGenType - generated type which contains type

type - JAVA type for which is the string with type info generated

imports - map of necessary imports for parentGenType

Returns:

string with type name for type in the full format or in the short format

wrapToDocumentation

public static String wrapToDocumentation(String text)

Wraps text as documentation

Parameters:

text - text for wrapping

Returns:

wrapped text

encodeJavadocSymbols

public static String encodeJavadocSymbols(String description)