interfaceBuilder.
*
* The method signature builder is created for the getter method of
* schemaNodeName. Also comment and
* returnType information are added to the builder.
*
* @param interfaceBuilder
* generated type builder for which the getter method should be
* created
* @param schemaNodeName
* string with schema node name. The name will be the part of the
* getter method name.
* @param comment
* string with comment for the getter method
* @param returnType
* type which represents the return type of the getter method
* @param status
* status from yang file, for deprecated annotation
* @return method signature builder which represents the getter method of
* interfaceBuilder
*/
static MethodSignatureBuilder constructGetter(final GeneratedTypeBuilder interfaceBuilder,
final String schemaNodeName, final String comment, final Type returnType, final Status status) {
final MethodSignatureBuilder getMethod = interfaceBuilder
.addMethod(getterMethodName(schemaNodeName, returnType));
if (status == Status.DEPRECATED) {
getMethod.addAnnotation("", "Deprecated");
}
getMethod.setComment(encodeAngleBrackets(comment));
getMethod.setReturnType(returnType);
return getMethod;
}
/**
* Creates the name of the getter method name from localName.
*
* @param localName
* string with the name of the getter method
* @param returnType
* return type
* @return string with the name of the getter method for
* methodName in JAVA method format
*/
private static String getterMethodName(final String localName, final Type returnType) {
final StringBuilder method = new StringBuilder();
if (BOOLEAN.equals(returnType)) {
method.append("is");
} else {
method.append("get");
}
final String name = BindingMapping.toFirstUpper(NonJavaCharsConverter.convertIdentifier(BindingMapping.getPropertyName
(localName), JavaIdentifier.METHOD));
method.append(name);
return method.toString();
}
static String createDescription(final SchemaNode schemaNode, final String fullyQualifiedName,
final SchemaContext schemaContext, final boolean verboseClassComments) {
final StringBuilder sb = new StringBuilder();
final String nodeDescription = encodeAngleBrackets(schemaNode.getDescription());
final String formattedDescription = YangTextTemplate.formatToParagraph(nodeDescription, 0);
if (!Strings.isNullOrEmpty(formattedDescription)) {
sb.append(formattedDescription);
sb.append(NEW_LINE);
}
if (verboseClassComments) {
final Module module = SchemaContextUtil.findParentModule(schemaContext, schemaNode);
final StringBuilder linkToBuilderClass = new StringBuilder();
final String[] namespace = Iterables.toArray(BSDOT_SPLITTER.split(fullyQualifiedName), String.class);
final String className = namespace[namespace.length - 1];
if (hasBuilderClass(schemaNode)) {
linkToBuilderClass.append(className);
linkToBuilderClass.append("Builder");
}
sb.append(""); sb.append("This class represents the following YANG schema fragment defined in module "); sb.append(module.getName()); sb.append(""); sb.append(NEW_LINE); sb.append("
");
sb.append(NEW_LINE);
sb.append(encodeAngleBrackets(yangTemplateForNode.render(schemaNode).body()));
sb.append("");
sb.append(NEW_LINE);
sb.append("The schema path to identify an instance is");
sb.append(NEW_LINE);
sb.append("");
sb.append(YangTextTemplate.formatSchemaPath(module.getName(), schemaNode.getPath().getPathFromRoot()));
sb.append("");
sb.append(NEW_LINE);
if (hasBuilderClass(schemaNode)) {
sb.append(NEW_LINE);
sb.append("To create instances of this class use " + "{@link " + linkToBuilderClass + "}.");
sb.append(NEW_LINE);
sb.append("@see ");
sb.append(linkToBuilderClass);
sb.append(NEW_LINE);
if (schemaNode instanceof ListSchemaNode) {
final List ");
sb.append("This class represents the following YANG schema fragment defined in module ");
sb.append(module.getName());
sb.append("");
sb.append(NEW_LINE);
sb.append("");
sb.append(NEW_LINE);
sb.append(encodeAngleBrackets(yangTemplateForModule.render(module).body()));
sb.append("");
}
return replaceAllIllegalChars(sb);
}
/**
* Returns first unique name for the augment generated type builder. The
* generated type builder name for augment consists from name of augmented
* node and serial number of its augmentation.
*
* @param builders
* map of builders which were created in the package to which the
* augmentation belongs
* @param genTypeName
* string with name of augmented node
* @return string with unique name for augmentation builder
*/
static String augGenTypeName(final Map