| /* |
| * Copyright 2016-present Open Networking Laboratory |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| package org.onosproject.yangutils.translator.tojava.utils; |
| |
| import org.onosproject.yangutils.datamodel.YangAtomicPath; |
| import org.onosproject.yangutils.datamodel.YangBit; |
| import org.onosproject.yangutils.datamodel.YangBits; |
| import org.onosproject.yangutils.datamodel.YangCompilerAnnotation; |
| import org.onosproject.yangutils.datamodel.YangEnum; |
| import org.onosproject.yangutils.datamodel.YangEnumeration; |
| import org.onosproject.yangutils.datamodel.YangNode; |
| import org.onosproject.yangutils.datamodel.utils.builtindatatype.YangDataTypes; |
| import org.onosproject.yangutils.translator.tojava.JavaAttributeInfo; |
| import org.onosproject.yangutils.translator.tojava.JavaFileInfoContainer; |
| import org.onosproject.yangutils.utils.io.YangPluginConfig; |
| import org.onosproject.yangutils.utils.io.impl.JavaDocGen; |
| |
| import java.util.LinkedHashMap; |
| import java.util.List; |
| import java.util.Map; |
| |
| import static org.onosproject.yangutils.translator.tojava.GeneratedJavaFileType.GENERATE_EVENT_SUBJECT_CLASS; |
| import static org.onosproject.yangutils.translator.tojava.GeneratedJavaFileType.GENERATE_SERVICE_AND_MANAGER; |
| import static org.onosproject.yangutils.translator.tojava.utils.BracketType.OPEN_CLOSE_BRACKET; |
| import static org.onosproject.yangutils.translator.tojava.utils.BracketType.OPEN_CLOSE_BRACKET_WITH_VALUE; |
| import static org.onosproject.yangutils.translator.tojava.utils.IndentationType.EIGHT_SPACE; |
| import static org.onosproject.yangutils.translator.tojava.utils.IndentationType.FOUR_SPACE; |
| import static org.onosproject.yangutils.translator.tojava.utils.JavaCodeSnippetGen.getAugmentMapTypeString; |
| import static org.onosproject.yangutils.translator.tojava.utils.JavaFileGeneratorUtils.getAugmentedClassNameForDataMethods; |
| import static org.onosproject.yangutils.translator.tojava.utils.JavaFileGeneratorUtils.getCurNodeName; |
| import static org.onosproject.yangutils.translator.tojava.utils.JavaFileGeneratorUtils.getSetOfNodeIdentifiers; |
| import static org.onosproject.yangutils.translator.tojava.utils.JavaIdentifierSyntax.getEnumJavaAttribute; |
| import static org.onosproject.yangutils.translator.tojava.utils.MethodBodyTypes.AUGMENTED_MAP_ADD; |
| import static org.onosproject.yangutils.translator.tojava.utils.MethodBodyTypes.AUGMENTED_MAP_GETTER; |
| import static org.onosproject.yangutils.translator.tojava.utils.MethodBodyTypes.AUGMENTED_MAP_GET_VALUE; |
| import static org.onosproject.yangutils.translator.tojava.utils.MethodBodyTypes.GETTER; |
| import static org.onosproject.yangutils.translator.tojava.utils.MethodBodyTypes.MANAGER_METHODS; |
| import static org.onosproject.yangutils.translator.tojava.utils.MethodBodyTypes.SETTER; |
| import static org.onosproject.yangutils.translator.tojava.utils.MethodBodyTypes.TO_STRING; |
| import static org.onosproject.yangutils.translator.tojava.utils.MethodClassTypes.CLASS_TYPE; |
| import static org.onosproject.yangutils.translator.tojava.utils.MethodClassTypes.INTERFACE_TYPE; |
| import static org.onosproject.yangutils.translator.tojava.utils.StringGenerator.brackets; |
| import static org.onosproject.yangutils.translator.tojava.utils.StringGenerator.getCompareToString; |
| import static org.onosproject.yangutils.translator.tojava.utils.StringGenerator.getGreaterThanCondition; |
| import static org.onosproject.yangutils.translator.tojava.utils.StringGenerator.getIfConditionBegin; |
| import static org.onosproject.yangutils.translator.tojava.utils.StringGenerator.getLesserThanCondition; |
| import static org.onosproject.yangutils.translator.tojava.utils.StringGenerator.getNewInstance; |
| import static org.onosproject.yangutils.translator.tojava.utils.StringGenerator.getOverRideString; |
| import static org.onosproject.yangutils.translator.tojava.utils.StringGenerator.getReturnString; |
| import static org.onosproject.yangutils.translator.tojava.utils.StringGenerator.ifAndAndCondition; |
| import static org.onosproject.yangutils.translator.tojava.utils.StringGenerator.ifConditionForIntInTypeDefConstructor; |
| import static org.onosproject.yangutils.translator.tojava.utils.StringGenerator.ifEqualEqualCondition; |
| import static org.onosproject.yangutils.translator.tojava.utils.StringGenerator.methodBody; |
| import static org.onosproject.yangutils.translator.tojava.utils.StringGenerator.methodClose; |
| import static org.onosproject.yangutils.translator.tojava.utils.StringGenerator.methodSignature; |
| import static org.onosproject.yangutils.translator.tojava.utils.StringGenerator.methodSignatureClose; |
| import static org.onosproject.yangutils.translator.tojava.utils.StringGenerator.multiAttrMethodSignature; |
| import static org.onosproject.yangutils.translator.tojava.utils.StringGenerator.signatureClose; |
| import static org.onosproject.yangutils.utils.UtilConstants.ADD; |
| import static org.onosproject.yangutils.utils.UtilConstants.ADD_STRING; |
| import static org.onosproject.yangutils.utils.UtilConstants.AND; |
| import static org.onosproject.yangutils.utils.UtilConstants.ARRAY_LIST; |
| import static org.onosproject.yangutils.utils.UtilConstants.AUGMENTED; |
| import static org.onosproject.yangutils.utils.UtilConstants.BASE64; |
| import static org.onosproject.yangutils.utils.UtilConstants.BIG_INTEGER; |
| import static org.onosproject.yangutils.utils.UtilConstants.BOOLEAN_DATA_TYPE; |
| import static org.onosproject.yangutils.utils.UtilConstants.BUILD; |
| import static org.onosproject.yangutils.utils.UtilConstants.BUILDER; |
| import static org.onosproject.yangutils.utils.UtilConstants.BUILDER_LOWER_CASE; |
| import static org.onosproject.yangutils.utils.UtilConstants.CASE; |
| import static org.onosproject.yangutils.utils.UtilConstants.CLASS; |
| import static org.onosproject.yangutils.utils.UtilConstants.CLASS_STRING; |
| import static org.onosproject.yangutils.utils.UtilConstants.CLOSE_CURLY_BRACKET; |
| import static org.onosproject.yangutils.utils.UtilConstants.CLOSE_PARENTHESIS; |
| import static org.onosproject.yangutils.utils.UtilConstants.COLON; |
| import static org.onosproject.yangutils.utils.UtilConstants.COMMA; |
| import static org.onosproject.yangutils.utils.UtilConstants.DECODE; |
| import static org.onosproject.yangutils.utils.UtilConstants.DEFAULT; |
| import static org.onosproject.yangutils.utils.UtilConstants.DEFAULT_CAPS; |
| import static org.onosproject.yangutils.utils.UtilConstants.EIGHT_SPACE_INDENTATION; |
| import static org.onosproject.yangutils.utils.UtilConstants.ELSE; |
| import static org.onosproject.yangutils.utils.UtilConstants.ELSE_IF; |
| import static org.onosproject.yangutils.utils.UtilConstants.EMPTY_PARAMETER_FUNCTION_CALL; |
| import static org.onosproject.yangutils.utils.UtilConstants.EMPTY_STRING; |
| import static org.onosproject.yangutils.utils.UtilConstants.ENUM; |
| import static org.onosproject.yangutils.utils.UtilConstants.EQUAL; |
| import static org.onosproject.yangutils.utils.UtilConstants.EQUALS_STRING; |
| import static org.onosproject.yangutils.utils.UtilConstants.FALSE; |
| import static org.onosproject.yangutils.utils.UtilConstants.FOR; |
| import static org.onosproject.yangutils.utils.UtilConstants.FOR_TYPE_STRING; |
| import static org.onosproject.yangutils.utils.UtilConstants.FOUR_SPACE_INDENTATION; |
| import static org.onosproject.yangutils.utils.UtilConstants.FROM_STRING_METHOD_NAME; |
| import static org.onosproject.yangutils.utils.UtilConstants.FROM_STRING_PARAM_NAME; |
| import static org.onosproject.yangutils.utils.UtilConstants.GET; |
| import static org.onosproject.yangutils.utils.UtilConstants.GET_DECODER; |
| import static org.onosproject.yangutils.utils.UtilConstants.GET_METHOD_PREFIX; |
| import static org.onosproject.yangutils.utils.UtilConstants.GOOGLE_MORE_OBJECT_METHOD_STRING; |
| import static org.onosproject.yangutils.utils.UtilConstants.HASH; |
| import static org.onosproject.yangutils.utils.UtilConstants.HASH_CODE_STRING; |
| import static org.onosproject.yangutils.utils.UtilConstants.IF; |
| import static org.onosproject.yangutils.utils.UtilConstants.INSTANCE_OF; |
| import static org.onosproject.yangutils.utils.UtilConstants.INT; |
| import static org.onosproject.yangutils.utils.UtilConstants.INTEGER_WRAPPER; |
| import static org.onosproject.yangutils.utils.UtilConstants.IS_SELECT_LEAF; |
| import static org.onosproject.yangutils.utils.UtilConstants.LEAF; |
| import static org.onosproject.yangutils.utils.UtilConstants.LEAF_IDENTIFIER; |
| import static org.onosproject.yangutils.utils.UtilConstants.LONG; |
| import static org.onosproject.yangutils.utils.UtilConstants.MAP; |
| import static org.onosproject.yangutils.utils.UtilConstants.MAX_RANGE; |
| import static org.onosproject.yangutils.utils.UtilConstants.MIN_RANGE; |
| import static org.onosproject.yangutils.utils.UtilConstants.NEW; |
| import static org.onosproject.yangutils.utils.UtilConstants.NEW_LINE; |
| import static org.onosproject.yangutils.utils.UtilConstants.NULL; |
| import static org.onosproject.yangutils.utils.UtilConstants.OBJ; |
| import static org.onosproject.yangutils.utils.UtilConstants.OBJECT; |
| import static org.onosproject.yangutils.utils.UtilConstants.OBJECT_STRING; |
| import static org.onosproject.yangutils.utils.UtilConstants.OF; |
| import static org.onosproject.yangutils.utils.UtilConstants.ONE; |
| import static org.onosproject.yangutils.utils.UtilConstants.OPEN_CURLY_BRACKET; |
| import static org.onosproject.yangutils.utils.UtilConstants.OPEN_PARENTHESIS; |
| import static org.onosproject.yangutils.utils.UtilConstants.OP_PARAM; |
| import static org.onosproject.yangutils.utils.UtilConstants.OTHER; |
| import static org.onosproject.yangutils.utils.UtilConstants.OVERRIDE; |
| import static org.onosproject.yangutils.utils.UtilConstants.PARSE_INT; |
| import static org.onosproject.yangutils.utils.UtilConstants.PATTERN; |
| import static org.onosproject.yangutils.utils.UtilConstants.PERIOD; |
| import static org.onosproject.yangutils.utils.UtilConstants.PRIVATE; |
| import static org.onosproject.yangutils.utils.UtilConstants.PROCESS_SUBTREE_FILTERING; |
| import static org.onosproject.yangutils.utils.UtilConstants.PROTECTED; |
| import static org.onosproject.yangutils.utils.UtilConstants.PUBLIC; |
| import static org.onosproject.yangutils.utils.UtilConstants.QUOTE_STRING; |
| import static org.onosproject.yangutils.utils.UtilConstants.QUOTES; |
| import static org.onosproject.yangutils.utils.UtilConstants.REPLACE_STRING; |
| import static org.onosproject.yangutils.utils.UtilConstants.RETURN; |
| import static org.onosproject.yangutils.utils.UtilConstants.RPC_INPUT_VAR_NAME; |
| import static org.onosproject.yangutils.utils.UtilConstants.SCHEMA_NAME; |
| import static org.onosproject.yangutils.utils.UtilConstants.SELECT_ALL_CHILD; |
| import static org.onosproject.yangutils.utils.UtilConstants.SEMI_COLON; |
| import static org.onosproject.yangutils.utils.UtilConstants.SET_METHOD_PREFIX; |
| import static org.onosproject.yangutils.utils.UtilConstants.SET_SELECT_LEAF; |
| import static org.onosproject.yangutils.utils.UtilConstants.SINGLE_QUOTE; |
| import static org.onosproject.yangutils.utils.UtilConstants.SIXTEEN_SPACE_INDENTATION; |
| import static org.onosproject.yangutils.utils.UtilConstants.SPACE; |
| import static org.onosproject.yangutils.utils.UtilConstants.SPLIT_STRING; |
| import static org.onosproject.yangutils.utils.UtilConstants.SQUARE_BRACKETS; |
| import static org.onosproject.yangutils.utils.UtilConstants.STATIC; |
| import static org.onosproject.yangutils.utils.UtilConstants.STRING_DATA_TYPE; |
| import static org.onosproject.yangutils.utils.UtilConstants.SUFFIX_S; |
| import static org.onosproject.yangutils.utils.UtilConstants.SWITCH; |
| import static org.onosproject.yangutils.utils.UtilConstants.THIS; |
| import static org.onosproject.yangutils.utils.UtilConstants.TMP_VAL; |
| import static org.onosproject.yangutils.utils.UtilConstants.TO; |
| import static org.onosproject.yangutils.utils.UtilConstants.TO_CAPS; |
| import static org.onosproject.yangutils.utils.UtilConstants.TRIM_STRING; |
| import static org.onosproject.yangutils.utils.UtilConstants.TRUE; |
| import static org.onosproject.yangutils.utils.UtilConstants.TWELVE_SPACE_INDENTATION; |
| import static org.onosproject.yangutils.utils.UtilConstants.TWENTY_SPACE_INDENTATION; |
| import static org.onosproject.yangutils.utils.UtilConstants.VALIDATE_RANGE; |
| import static org.onosproject.yangutils.utils.UtilConstants.VALUE; |
| import static org.onosproject.yangutils.utils.UtilConstants.VALUE_LEAF_SET; |
| import static org.onosproject.yangutils.utils.UtilConstants.VOID; |
| import static org.onosproject.yangutils.utils.UtilConstants.YANG_AUGMENTED_INFO; |
| import static org.onosproject.yangutils.utils.UtilConstants.YANG_AUGMENTED_INFO_LOWER_CASE; |
| import static org.onosproject.yangutils.utils.UtilConstants.ZERO; |
| import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.JavaDocType.BUILD_METHOD; |
| import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.JavaDocType.CONSTRUCTOR; |
| import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.JavaDocType.DEFAULT_CONSTRUCTOR; |
| import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.JavaDocType.FROM_METHOD; |
| import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.JavaDocType.GETTER_METHOD; |
| import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.JavaDocType.MANAGER_SETTER_METHOD; |
| import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.JavaDocType.OF_METHOD; |
| import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.JavaDocType.SETTER_METHOD; |
| import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.JavaDocType.TYPE_CONSTRUCTOR; |
| import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.generateForAddAugmentation; |
| import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.generateForBuilderMethod; |
| import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.generateForGetAugmentation; |
| import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.generateForGetMethodWithAttribute; |
| import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.generateForValidatorMethod; |
| import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.getJavaDoc; |
| import static org.onosproject.yangutils.utils.io.impl.YangIoUtils.getCamelCase; |
| import static org.onosproject.yangutils.utils.io.impl.YangIoUtils.getCapitalCase; |
| import static org.onosproject.yangutils.utils.io.impl.YangIoUtils.getSmallCase; |
| import static org.onosproject.yangutils.utils.io.impl.YangIoUtils.trimAtLast; |
| |
| /** |
| * Represents generator for methods of generated files based on the file type. |
| */ |
| public final class MethodsGenerator { |
| private static final String BITS_STRING_ARRAY_VAR = "bitsTemp"; |
| private static final String BIT_TEMP_VAR = "bitTemp"; |
| private static final String BIT_NAMES_VAR = "bitNames"; |
| private static final String BIT_NAME_VAR = "bitName"; |
| |
| /** |
| * Creates an instance of method generator. |
| */ |
| private MethodsGenerator() { |
| } |
| |
| /** |
| * Returns the methods strings for builder interface. |
| * |
| * @param name attribute name |
| * @return method string for builder interface |
| */ |
| public static String parseBuilderInterfaceBuildMethodString(String name) { |
| return getJavaDoc(BUILD_METHOD, name, false, null) + |
| getBuildForInterface(name); |
| } |
| |
| /** |
| * Returns getter string. |
| * |
| * @param attr attribute info |
| * @param genType generated java files |
| * @return getter string |
| */ |
| public static String getGetterString(JavaAttributeInfo attr, int genType) { |
| |
| String returnType = getReturnType(attr); |
| String attributeName = attr.getAttributeName(); |
| String appDataStructure = null; |
| StringBuilder builder = new StringBuilder(); |
| if (attr.getCompilerAnnotation() != null) { |
| appDataStructure = |
| attr.getCompilerAnnotation().getYangAppDataStructure() |
| .getDataStructure().name(); |
| } |
| if (genType == GENERATE_SERVICE_AND_MANAGER) { |
| builder.append(generateForGetMethodWithAttribute(returnType)) |
| .append(getGetterForInterface( |
| attributeName, returnType, attr.isListAttr(), |
| genType, attr.getCompilerAnnotation())); |
| |
| return builder.toString(); |
| } |
| |
| builder.append(getJavaDoc(GETTER_METHOD, attributeName, attr |
| .isListAttr(), appDataStructure)) |
| .append(getGetterForInterface( |
| attributeName, returnType, attr.isListAttr(), |
| genType, attr.getCompilerAnnotation())); |
| |
| return builder.toString(); |
| } |
| |
| /** |
| * Returns setter string. |
| * |
| * @param attr attribute info |
| * @param className java class name |
| * @param genType generated java files |
| * @return setter string |
| */ |
| public static String getSetterString(JavaAttributeInfo attr, |
| String className, int genType) { |
| |
| String attrType = getReturnType(attr); |
| String attributeName = attr.getAttributeName(); |
| JavaDocGen.JavaDocType type; |
| StringBuilder builder = new StringBuilder(); |
| if (genType == GENERATE_SERVICE_AND_MANAGER) { |
| type = MANAGER_SETTER_METHOD; |
| } else { |
| type = SETTER_METHOD; |
| } |
| |
| String appDataStructure = null; |
| if (attr.getCompilerAnnotation() != null) { |
| appDataStructure = |
| attr.getCompilerAnnotation().getYangAppDataStructure() |
| .getDataStructure().name(); |
| } |
| builder.append(getJavaDoc(type, attributeName, attr.isListAttr(), |
| appDataStructure)) |
| .append(getSetterForInterface(attributeName, attrType, className, |
| attr.isListAttr(), genType, |
| attr.getCompilerAnnotation())); |
| return builder.toString(); |
| } |
| |
| /** |
| * Returns constructor method string. |
| * |
| * @param name class name |
| * @return constructor string |
| */ |
| private static String getConstructorString(String name) { |
| return getJavaDoc(CONSTRUCTOR, name, false, null); |
| } |
| |
| /** |
| * Returns default constructor method string. |
| * |
| * @param name class name |
| * @param modifierType modifier type |
| * @return default constructor string |
| */ |
| public static String getDefaultConstructorString(String name, |
| String modifierType) { |
| return getJavaDoc(DEFAULT_CONSTRUCTOR, name, false, null) |
| + getDefaultConstructor(name, modifierType) + NEW_LINE; |
| } |
| |
| /** |
| * Returns build method string. |
| * |
| * @param name class name |
| * @param isRootNode if root node |
| * @return build string |
| */ |
| public static String getBuildString(String name, boolean isRootNode) { |
| if (isRootNode) { |
| return NEW_LINE + getBuild(name, true); |
| } |
| return FOUR_SPACE_INDENTATION + OVERRIDE + NEW_LINE + |
| getBuild(name, false); |
| } |
| |
| /** |
| * Returns the getter method strings for class file. |
| * |
| * @param attr attribute info |
| * @param generatedJavaFiles for the type of java file being generated |
| * @return getter method for class |
| */ |
| public static String getGetterForClass(JavaAttributeInfo attr, |
| int generatedJavaFiles) { |
| |
| String attrQualifiedType = getReturnType(attr); |
| String attributeName = attr.getAttributeName(); |
| |
| if (!attr.isListAttr()) { |
| return getGetter(attrQualifiedType, attributeName, |
| generatedJavaFiles); |
| } |
| String attrParam = StringGenerator.getListAttribute(attrQualifiedType, |
| attr.getCompilerAnnotation()); |
| return getGetter(attrParam, attributeName, generatedJavaFiles); |
| } |
| |
| /** |
| * Returns getter for attribute. |
| * |
| * @param type return type |
| * @param name attribute name |
| * @param genType generated java files |
| * @return getter for attribute |
| */ |
| static String getGetter(String type, String name, int genType) { |
| StringBuilder builder = new StringBuilder(); |
| if (genType == GENERATE_SERVICE_AND_MANAGER) { |
| //Append method signature. |
| builder.append(methodSignature(getCapitalCase(name), GET, |
| PUBLIC, null, type, null, |
| CLASS_TYPE)) |
| //Append method body. |
| .append(methodBody(MANAGER_METHODS, null, null, |
| EIGHT_SPACE_INDENTATION, null, |
| type, false)) |
| .append(signatureClose()) |
| //Append method close. |
| .append(methodClose(FOUR_SPACE)); |
| return builder.toString(); |
| } |
| builder.append(methodSignature(name, EMPTY_STRING, |
| PUBLIC, null, type, null, |
| CLASS_TYPE)) |
| //Append method body. |
| .append(methodBody(GETTER, name, name, |
| EIGHT_SPACE_INDENTATION, null, |
| type, false)) |
| .append(signatureClose()) |
| //Append method close. |
| .append(methodClose(FOUR_SPACE)); |
| return builder.toString(); |
| } |
| |
| /** |
| * Returns the setter method strings for class file. |
| * |
| * @param attr attribute info |
| * @param className name of the class |
| * @param generatedJavaFiles generated java files |
| * @return setter method for class |
| */ |
| public static String getSetterForClass(JavaAttributeInfo attr, |
| String className, |
| int generatedJavaFiles) { |
| String attrQualifiedType = getReturnType(attr); |
| String attributeName = attr.getAttributeName(); |
| boolean isTypeNull = false; |
| if (attr.getAttributeType() == null) { |
| isTypeNull = true; |
| } |
| if (!attr.isListAttr()) { |
| return getSetter(className, attributeName, attrQualifiedType, |
| generatedJavaFiles, isTypeNull, false); |
| } |
| String attrParam = StringGenerator.getListAttribute(attrQualifiedType, |
| attr.getCompilerAnnotation()); |
| return getSetter(className, attributeName, attrParam, |
| generatedJavaFiles, isTypeNull, true); |
| } |
| |
| /** |
| * Returns setter for attribute. |
| * |
| * @param className class name |
| * @param name attribute name |
| * @param type return type |
| * @param isTypeNull if attribute type is null |
| * @param isList true if leaf-list |
| * @return setter for attribute |
| */ |
| private static String getSetter(String className, String name, String type, |
| int genType, |
| boolean isTypeNull, boolean isList) { |
| StringBuilder builder = new StringBuilder(); |
| if (genType == GENERATE_SERVICE_AND_MANAGER) { |
| //Append method signature. |
| builder.append(methodSignature(getCapitalCase(name), |
| SET_METHOD_PREFIX, |
| PUBLIC, name, VOID, type, |
| CLASS_TYPE)) |
| //Append method body. |
| .append(methodBody(MANAGER_METHODS, null, null, |
| EIGHT_SPACE_INDENTATION, null, null, |
| false)) |
| .append(methodClose(FOUR_SPACE)); |
| return builder.toString(); |
| } |
| if (genType == GENERATE_EVENT_SUBJECT_CLASS) { |
| builder.append(methodSignature(name, EMPTY_STRING, PUBLIC, name, VOID, |
| type, CLASS_TYPE)) |
| |
| //Append method body. |
| .append(methodBody(SETTER, name, name, |
| EIGHT_SPACE_INDENTATION, null, null, |
| false)) |
| .append(methodClose(FOUR_SPACE)); |
| return builder.toString(); |
| } |
| builder.append(methodSignature(name, EMPTY_STRING, |
| PUBLIC, name, getCapitalCase(className) + |
| BUILDER, type, CLASS_TYPE)); |
| if (!isTypeNull && !isList) { |
| builder.append(StringGenerator.getValueLeafSetString(name)); |
| } else { |
| builder.append(EMPTY_STRING); |
| } |
| //Append method body. |
| builder.append(methodBody(SETTER, name, name, |
| EIGHT_SPACE_INDENTATION, null, null, |
| true)) |
| //Append method close. |
| .append(methodClose(FOUR_SPACE)); |
| return builder.toString(); |
| } |
| |
| /** |
| * Returns the setter method strings for class file. |
| * |
| * @param attr attribute info |
| * @return setter method for class |
| */ |
| static String getSetterForTypeDefClass(JavaAttributeInfo attr) { |
| |
| String attrQualifiedType = getReturnType(attr); |
| String attributeName = attr.getAttributeName(); |
| return getTypeDefSetter(attrQualifiedType, attributeName); |
| } |
| |
| /** |
| * Returns type def's setter for attribute. |
| * |
| * @param type data type |
| * @param name attribute name |
| * @return setter for type def's attribute |
| */ |
| private static String getTypeDefSetter(String type, String name) { |
| return methodSignature(getCapitalCase(name), SET_METHOD_PREFIX, PUBLIC, |
| name, VOID, type, CLASS_TYPE) + |
| methodBody(SETTER, name, name, EIGHT_SPACE_INDENTATION, null, |
| null, false) + methodClose(FOUR_SPACE); |
| } |
| |
| /** |
| * Returns the getter method strings for interface file. |
| * |
| * @param yangName name of the attribute |
| * @param returnType return type of attribute |
| * @param isList is list attribute |
| * @param genType generated java files |
| * @param annotation compiler annotation |
| * @return getter method for interface |
| */ |
| static String getGetterForInterface(String yangName, String returnType, |
| boolean isList, |
| int genType, |
| YangCompilerAnnotation annotation) { |
| if (!isList) { |
| return getGetterInterfaceString(returnType, yangName, |
| genType); |
| } |
| String listAttr = StringGenerator.getListAttribute(returnType, annotation); |
| return getGetterInterfaceString(listAttr, yangName, genType); |
| } |
| |
| /** |
| * Returns getter for attribute in interface. |
| * |
| * @param returnType return type |
| * @param yangName attribute name |
| * @return getter for interface |
| */ |
| private static String getGetterInterfaceString(String returnType, |
| String yangName, |
| int genType) { |
| switch (genType) { |
| case GENERATE_SERVICE_AND_MANAGER: |
| return getGetMethodWithArgument(returnType, yangName); |
| default: |
| return methodSignature(yangName, EMPTY_STRING, null, |
| null, returnType, null, INTERFACE_TYPE); |
| } |
| } |
| |
| /** |
| * Returns the setter method strings for interface file. |
| * |
| * @param attrName name of the attribute |
| * @param attrType return type of attribute |
| * @param className name of the java class being generated |
| * @param isList is list attribute |
| * @param genType generated java files |
| * @param annotation compiler annotations |
| * @return setter method for interface |
| */ |
| static String getSetterForInterface(String attrName, String attrType, |
| String className, |
| boolean isList, int genType, |
| YangCompilerAnnotation annotation) { |
| if (!isList) { |
| return getSetterInterfaceString(className, attrName, attrType, |
| genType); |
| } |
| |
| String listAttr = StringGenerator.getListAttribute(attrType, annotation); |
| return getSetterInterfaceString(className, attrName, listAttr, genType); |
| } |
| |
| /** |
| * Returns setter string for interface. |
| * |
| * @param name class name |
| * @param attrName attribute name |
| * @param attrType attribute type |
| * @return setter string |
| */ |
| private static String getSetterInterfaceString(String name, |
| String attrName, |
| String attrType, |
| int genType) { |
| if (genType == GENERATE_SERVICE_AND_MANAGER) { |
| return methodSignature(getCapitalCase(attrName), |
| SET_METHOD_PREFIX, |
| null, attrName, VOID, attrType + |
| OP_PARAM, INTERFACE_TYPE); |
| } |
| return methodSignature(attrName, EMPTY_STRING, null, |
| attrName, name + BUILDER, attrType, INTERFACE_TYPE); |
| } |
| |
| /** |
| * Returns return type for attribute. |
| * |
| * @param attr attribute info |
| * @return return type |
| */ |
| private static String getReturnType(JavaAttributeInfo attr) { |
| String returnType; |
| StringBuilder builder = new StringBuilder(); |
| if (attr.isQualifiedName() && |
| attr.getImportInfo().getPkgInfo() != null) { |
| returnType = attr.getImportInfo().getPkgInfo() + PERIOD; |
| builder.append(returnType); |
| } |
| returnType = attr.getImportInfo().getClassInfo(); |
| builder.append(returnType); |
| return builder.toString(); |
| } |
| |
| /** |
| * Returns the build method strings for interface file. |
| * |
| * @param yangName name of the interface |
| * @return build method for interface |
| */ |
| static String getBuildForInterface(String yangName) { |
| return methodSignature(BUILD, EMPTY_STRING, null, null, |
| yangName, null, INTERFACE_TYPE); |
| } |
| |
| /** |
| * Returns constructor string for impl class. |
| * |
| * @param yangName class name |
| * @param isRootNode if root node |
| * @return constructor string |
| */ |
| static String getConstructorStart(String yangName, |
| boolean isRootNode) { |
| StringBuilder builder = new StringBuilder( |
| getConstructorString(yangName)); |
| |
| String name = getCapitalCase(yangName); |
| String returnType = DEFAULT_CAPS + name; |
| if (isRootNode) { |
| returnType = name + OP_PARAM; |
| } |
| builder.append(methodSignature( |
| returnType, EMPTY_STRING, PROTECTED, BUILDER_LOWER_CASE + OBJECT, |
| null, name + BUILDER, CLASS_TYPE)); |
| return builder.toString(); |
| } |
| |
| /** |
| * Returns the constructor strings for class file. |
| * |
| * @param attr attribute info |
| * @param genType generated java files |
| * @return constructor for class |
| */ |
| public static String getConstructor(JavaAttributeInfo attr, int genType) { |
| String attrName = attr.getAttributeName(); |
| String attrCaps = getCapitalCase(attrName); |
| switch (genType) { |
| case GENERATE_SERVICE_AND_MANAGER: |
| return methodBody(MethodBodyTypes.CONSTRUCTOR, attrName, |
| attrCaps, EIGHT_SPACE_INDENTATION, GET, null, |
| false); |
| default: |
| return methodBody(MethodBodyTypes.CONSTRUCTOR, attrName, |
| attrName, EIGHT_SPACE_INDENTATION, EMPTY_STRING, |
| null, false); |
| } |
| } |
| |
| /** |
| * Returns the rpc strings for service interface. |
| * |
| * @param rpcName name of the rpc |
| * @param input name of input |
| * @param output name of output |
| * @return rpc method string |
| */ |
| public static String getRpcServiceMethod(String rpcName, String input, |
| String output) { |
| String inputVal = EMPTY_STRING; |
| if (!input.equals(EMPTY_STRING)) { |
| inputVal = RPC_INPUT_VAR_NAME; |
| } |
| return methodSignature(rpcName, EMPTY_STRING, null, |
| inputVal, output, input, INTERFACE_TYPE) + |
| NEW_LINE; |
| } |
| |
| /** |
| * Returns the build method strings for class file. |
| * |
| * @param yangName class name |
| * @param isRootNode if root node |
| * @return build method string for class |
| */ |
| static String getBuild(String yangName, boolean isRootNode) { |
| String type = DEFAULT_CAPS + yangName; |
| if (isRootNode) { |
| type = yangName + OP_PARAM; |
| } |
| return methodSignature(BUILD, EMPTY_STRING, PUBLIC, null, |
| yangName, null, |
| CLASS_TYPE) + |
| methodBody(MethodBodyTypes.BUILD, type, BUILD, |
| EIGHT_SPACE_INDENTATION, EMPTY_STRING, |
| null, false) + |
| methodClose(FOUR_SPACE); |
| } |
| |
| /** |
| * Returns the Default constructor strings for class file. |
| * |
| * @param name name of the class |
| * @param modifierType modifier type for default constructor |
| * @return Default constructor for class |
| */ |
| private static String getDefaultConstructor(String name, |
| String modifierType) { |
| return methodSignature(name, EMPTY_STRING, modifierType, null, |
| null, null, CLASS_TYPE) + |
| methodClose(FOUR_SPACE); |
| } |
| |
| /** |
| * Returns to string method's open strings. |
| * |
| * @return string method's open string |
| */ |
| static String getToStringMethodOpen() { |
| String line; |
| StringBuilder builder = new StringBuilder(getOverRideString()); |
| builder.append(methodSignature(TO + STRING_DATA_TYPE, EMPTY_STRING, |
| PUBLIC, null, STRING_DATA_TYPE, null, |
| CLASS_TYPE)); |
| line = getReturnString(GOOGLE_MORE_OBJECT_METHOD_STRING, |
| EIGHT_SPACE_INDENTATION) + NEW_LINE; |
| builder.append(line); |
| return builder.toString(); |
| } |
| |
| /** |
| * Returns to string method's close string. |
| * |
| * @return to string method close string |
| */ |
| static String getToStringMethodClose() { |
| return TWELVE_SPACE_INDENTATION + PERIOD + TO + STRING_DATA_TYPE + |
| brackets(OPEN_CLOSE_BRACKET, null, null) + signatureClose() + |
| methodClose(FOUR_SPACE); |
| } |
| |
| /** |
| * Returns to string method for class. |
| * |
| * @param attr attribute info |
| * @return to string method |
| */ |
| public static String getToStringMethod(JavaAttributeInfo attr) { |
| String attributeName = attr.getAttributeName(); |
| return methodBody(TO_STRING, attributeName, null, |
| TWELVE_SPACE_INDENTATION, null, null, false); |
| } |
| |
| /** |
| * Returns from string method's open string. |
| * |
| * @param className name of the class |
| * @return from string method's open string |
| */ |
| static String getFromStringMethodSignature(String className) { |
| return getJavaDoc(FROM_METHOD, className, false, null) + |
| methodSignature(FROM_STRING_METHOD_NAME, EMPTY_STRING, PUBLIC + |
| SPACE + STATIC, FROM_STRING_PARAM_NAME, |
| className, STRING_DATA_TYPE, |
| CLASS_TYPE); |
| } |
| |
| /** |
| * Return from string method's close string. |
| * |
| * @return from string method's close string |
| */ |
| static String getFromStringMethodClose() { |
| return getReturnString(NULL, EIGHT_SPACE_INDENTATION) + |
| signatureClose() + methodClose(FOUR_SPACE); |
| } |
| |
| /** |
| * Return from string method's body string. |
| * |
| * @param attr attribute info |
| * @param fromAttr attribute info for the from string wrapper |
| * type |
| * @return from string method's body string |
| */ |
| public static String getFromStringMethod(JavaAttributeInfo attr, |
| JavaAttributeInfo fromAttr) { |
| |
| return EIGHT_SPACE_INDENTATION + StringGenerator.getTrySubString() + |
| StringGenerator.getNewLineAndSpace(TWELVE_SPACE_INDENTATION) + |
| getParsedSubString(attr, fromAttr) + |
| StringGenerator.getNewLineAndSpace(FOUR_SPACE_INDENTATION) + |
| StringGenerator.getReturnOfSubString() + |
| StringGenerator.getNewLineAndSpace(EIGHT_SPACE_INDENTATION) + |
| StringGenerator.getCatchSubString() + |
| StringGenerator.getNewLineAndSpace(EIGHT_SPACE_INDENTATION) + |
| CLOSE_CURLY_BRACKET; |
| } |
| |
| /** |
| * Returns sub string with parsed statement for union's from string method. |
| * |
| * @param attr attribute info |
| * @return sub string with parsed statement for union's from string method |
| */ |
| private static String getParsedSubString(JavaAttributeInfo attr, |
| JavaAttributeInfo fromStringAttr) { |
| |
| String targetDataType = getReturnType(attr); |
| StringBuilder builder = new StringBuilder(); |
| YangDataTypes types = fromStringAttr.getAttributeType() |
| .getDataType(); |
| switch (types) { |
| case BITS: |
| return getFromStringForBits(attr, (YangBits) fromStringAttr.getAttributeType() |
| .getDataTypeExtendedInfo()); |
| case BINARY: |
| return targetDataType + SPACE + TMP_VAL + SPACE + EQUAL + SPACE + |
| BASE64 + PERIOD + GET_DECODER + OPEN_PARENTHESIS + |
| CLOSE_PARENTHESIS + PERIOD + DECODE + OPEN_PARENTHESIS + |
| FROM_STRING_PARAM_NAME + CLOSE_PARENTHESIS + SEMI_COLON |
| + NEW_LINE; |
| default: |
| return targetDataType + SPACE + TMP_VAL + SPACE + EQUAL + |
| SPACE + StringGenerator.getParseFromStringMethod( |
| targetDataType, fromStringAttr.getAttributeType()) + |
| OPEN_PARENTHESIS + FROM_STRING_PARAM_NAME + |
| CLOSE_PARENTHESIS + SEMI_COLON + NEW_LINE; |
| } |
| } |
| |
| /** |
| * Returns hash code method open strings. |
| * |
| * @return hash code method open string |
| */ |
| static String getHashCodeMethodOpen() { |
| String line; |
| StringBuilder builder = new StringBuilder(getOverRideString()); |
| builder.append(methodSignature(HASH_CODE_STRING, EMPTY_STRING, PUBLIC, |
| null, INT, null, CLASS_TYPE)); |
| line = getReturnString(OBJECT_STRING + SUFFIX_S + PERIOD + HASH + |
| OPEN_PARENTHESIS, EIGHT_SPACE_INDENTATION); |
| builder.append(line); |
| return builder.toString(); |
| } |
| |
| /** |
| * Returns hash code methods close string. |
| * |
| * @param hashcodeString hash code string |
| * @return to hash code method close string |
| */ |
| static String getHashCodeMethodClose(String hashcodeString) { |
| String[] array = {SPACE, COMMA}; |
| hashcodeString = trimAtLast(hashcodeString, array); |
| return hashcodeString + CLOSE_PARENTHESIS + signatureClose() + |
| methodClose(FOUR_SPACE); |
| } |
| |
| /** |
| * Returns hash code method for class. |
| * |
| * @param attr attribute info |
| * @return hash code method |
| */ |
| public static String getHashCodeMethod(JavaAttributeInfo attr) { |
| return attr.getAttributeName() + COMMA + SPACE; |
| } |
| |
| /** |
| * Returns equals method open strings. |
| * |
| * @param className class name |
| * @return equals method open string |
| */ |
| static String getEqualsMethodOpen(String className) { |
| return getOverRideString() + |
| methodSignature(EQUALS_STRING, EMPTY_STRING, PUBLIC, OBJ, |
| BOOLEAN_DATA_TYPE, OBJECT_STRING, |
| CLASS_TYPE) + |
| getEqualsMethodsCommonIfCondition() + |
| getEqualsMethodsSpecificIfCondition(className); |
| } |
| |
| /** |
| * Returns equal methods if condition string. |
| * |
| * @return if condition string |
| */ |
| private static String getEqualsMethodsCommonIfCondition() { |
| return getIfConditionBegin(EIGHT_SPACE_INDENTATION, THIS + SPACE + |
| EQUAL + EQUAL + SPACE + OBJ) + getReturnString( |
| TRUE, TWELVE_SPACE_INDENTATION) + signatureClose() |
| + methodClose(EIGHT_SPACE); |
| } |
| |
| /** |
| * Returns if condition for specific class object in equals method. |
| * |
| * @param className class name |
| * @return if condition string |
| */ |
| private static String getEqualsMethodsSpecificIfCondition(String className) { |
| return EIGHT_SPACE_INDENTATION + IF + SPACE + OPEN_PARENTHESIS + OBJ + |
| INSTANCE_OF + className + CLOSE_PARENTHESIS + SPACE + |
| OPEN_CURLY_BRACKET + NEW_LINE + TWELVE_SPACE_INDENTATION + |
| className + SPACE + OTHER + SPACE + EQUAL + SPACE + |
| OPEN_PARENTHESIS + className + CLOSE_PARENTHESIS + SPACE + OBJ + |
| SEMI_COLON + NEW_LINE + TWELVE_SPACE_INDENTATION + RETURN + |
| NEW_LINE; |
| } |
| |
| /** |
| * Returns equals methods close string. |
| * |
| * @param equalMethodString equal method string |
| * @return equals method close string |
| */ |
| static String getEqualsMethodClose(String equalMethodString) { |
| String[] array = {NEW_LINE, AND, AND, SPACE}; |
| equalMethodString = trimAtLast(equalMethodString, array) + |
| signatureClose(); |
| return equalMethodString + methodClose(EIGHT_SPACE) + |
| getReturnString(FALSE, EIGHT_SPACE_INDENTATION) + |
| signatureClose() + methodClose(FOUR_SPACE); |
| } |
| |
| /** |
| * Returns equals method for class. |
| * |
| * @param attr attribute info |
| * @return equals method |
| */ |
| public static String getEqualsMethod(JavaAttributeInfo attr) { |
| String attributeName = attr.getAttributeName(); |
| return SIXTEEN_SPACE_INDENTATION + OBJECT_STRING + SUFFIX_S + |
| PERIOD + EQUALS_STRING + OPEN_PARENTHESIS + attributeName + |
| COMMA + SPACE + OTHER + PERIOD + attributeName + |
| CLOSE_PARENTHESIS + SPACE + AND + AND; |
| } |
| |
| /** |
| * Returns of method's string and java doc for special type. |
| * |
| * @param attr attribute info |
| * @param className class name |
| * @return of method's string and java doc for special type |
| */ |
| public static String getOfMethodStringAndJavaDoc(JavaAttributeInfo attr, |
| String className) { |
| String attrType = getReturnType(attr); |
| String attrName = attr.getAttributeName(); |
| |
| return getJavaDoc(OF_METHOD, className + FOR_TYPE_STRING + attrName, |
| false, null) + getOfMethodString(attrType, className); |
| } |
| |
| /** |
| * Returns of method's string. |
| * |
| * @param type data type |
| * @param name class name |
| * @return of method's string |
| */ |
| private static String getOfMethodString(String type, String name) { |
| return methodSignature(OF, EMPTY_STRING, PUBLIC + SPACE + STATIC, |
| VALUE, name, type, CLASS_TYPE) + |
| methodBody(MethodBodyTypes.OF_METHOD, name, null, |
| EIGHT_SPACE_INDENTATION, EMPTY_STRING, null, false) + |
| methodClose(FOUR_SPACE); |
| } |
| |
| /** |
| * Returns string and java doc for constructor of type class. |
| * |
| * @param attr attribute info |
| * @param className class name |
| * @return string and java doc for constructor of type class |
| */ |
| public static String getTypeConstructorStringAndJavaDoc( |
| JavaAttributeInfo attr, String className) { |
| String attrType = getReturnType(attr); |
| String attrName = attr.getAttributeName(); |
| return getJavaDoc(TYPE_CONSTRUCTOR, attrName, false, null) + |
| getTypeConstructorString(attrType, attrName, className); |
| } |
| |
| /** |
| * Returns string and java doc for constructor of type class. |
| * |
| * @param attr1 first attribute info |
| * @param attr2 second attribute info |
| * @param genType class name |
| * @param type conflict validate type |
| * @param addFirst whether int came first or uInt came first |
| * @return string and java doc for constructor of type class |
| */ |
| public static String getTypeConstructorStringAndJavaDoc( |
| JavaAttributeInfo attr1, JavaAttributeInfo attr2, String genType, |
| ValidatorTypeForUnionTypes type, boolean addFirst) { |
| |
| String attrType = getReturnType(attr1); |
| String attrName1 = ""; |
| String attrName2 = ""; |
| if (attr1 != null) { |
| if (addFirst) { |
| attrName1 = attr1.getAttributeName(); |
| } else { |
| attrName2 = attr1.getAttributeName(); |
| } |
| } |
| if (attr2 != null) { |
| if (addFirst) { |
| attrName1 = attr2.getAttributeName(); |
| } else { |
| attrName2 = attr2.getAttributeName(); |
| } |
| } |
| |
| String appDataStructure = null; |
| if (attr1 != null && attr1.getCompilerAnnotation() != null) { |
| appDataStructure = |
| attr1.getCompilerAnnotation().getYangAppDataStructure() |
| .getDataStructure().name(); |
| } |
| String doc; |
| if (attrName1.isEmpty()) { |
| doc = attrName2; |
| } else { |
| doc = attrName1; |
| } |
| return getJavaDoc(TYPE_CONSTRUCTOR, doc, false, appDataStructure) + |
| getTypeConstructorString(attrType, attrName1, |
| attrName2, genType, |
| type, addFirst); |
| } |
| |
| /** |
| * Returns type constructor string. |
| * |
| * @param type data type |
| * @param name attribute name |
| * @param className class name |
| * @return type constructor string |
| */ |
| private static String getTypeConstructorString(String type, String name, |
| String className) { |
| return methodSignature(className, EMPTY_STRING, PUBLIC, name, |
| null, type, CLASS_TYPE) + |
| methodBody(SETTER, name, null, EIGHT_SPACE_INDENTATION, |
| EMPTY_STRING, null, false) + methodClose(FOUR_SPACE); |
| } |
| |
| /** |
| * Returns type constructor string. |
| * |
| * @param type data type |
| * @param attr1 attribute attr1 |
| * @param className class attr1 |
| * @return type constructor string |
| */ |
| private static String getTypeConstructorString( |
| String type, String attr1, String attr2, String className, |
| ValidatorTypeForUnionTypes validatorType, boolean addInt) { |
| |
| StringBuilder constructor = new StringBuilder( |
| methodSignature(className, EMPTY_STRING, null, type, |
| null, type, CLASS_TYPE)) |
| .append(ifConditionForIntInTypeDefConstructor(validatorType, |
| addInt)) |
| .append(methodBody(SETTER, attr1, null, |
| TWELVE_SPACE_INDENTATION, EMPTY_STRING, |
| null, false)); |
| String str = EIGHT_SPACE_INDENTATION + CLOSE_CURLY_BRACKET + SPACE + |
| ELSE + SPACE + OPEN_CURLY_BRACKET + NEW_LINE; |
| constructor.append(str) |
| .append(methodBody(SETTER, attr2, null, |
| TWELVE_SPACE_INDENTATION, EMPTY_STRING, |
| null, false)) |
| .append(methodClose(FOUR_SPACE)) |
| .append(methodClose(EIGHT_SPACE)); |
| |
| return constructor.toString(); |
| } |
| |
| /** |
| * Returns interface of add augmentation. |
| * |
| * @return interface of add augmentation |
| */ |
| static String getAddAugmentInfoMethodInterface() { |
| StringBuilder builder = new StringBuilder(generateForAddAugmentation()); |
| LinkedHashMap<String, String> map = new LinkedHashMap<>(); |
| map.put(OBJECT_STRING, VALUE); |
| map.put(CLASS_STRING, CLASS + OBJECT_STRING); |
| builder.append(multiAttrMethodSignature(ADD_STRING + YANG_AUGMENTED_INFO, |
| EMPTY_STRING, EMPTY_STRING, |
| VOID, map, INTERFACE_TYPE)); |
| return builder.toString(); |
| } |
| |
| /** |
| * Returns implementation of add augmentation. |
| * |
| * @return implementation of add augmentation |
| */ |
| static String getAddAugmentInfoMethodImpl() { |
| StringBuilder builder = new StringBuilder(getOverRideString()); |
| LinkedHashMap<String, String> map = new LinkedHashMap<>(); |
| map.put(OBJECT_STRING, VALUE); |
| map.put(CLASS_STRING, CLASS + OBJECT_STRING); |
| builder.append(multiAttrMethodSignature(ADD_STRING + YANG_AUGMENTED_INFO, |
| EMPTY_STRING, PUBLIC, |
| VOID, map, CLASS_TYPE)) |
| .append(methodBody(AUGMENTED_MAP_ADD, null, null, |
| EIGHT_SPACE_INDENTATION, null, null, false)) |
| .append(methodClose(FOUR_SPACE)) |
| .append(NEW_LINE); |
| return builder.toString(); |
| } |
| |
| /** |
| * Returns interface of get YANG augment info. |
| * |
| * @return interface of get YANG augment info |
| */ |
| static String getYangAugmentInfoInterface() { |
| return generateForGetAugmentation() + |
| methodSignature(YANG_AUGMENTED_INFO_LOWER_CASE, EMPTY_STRING, |
| null, CLASS + OBJECT_STRING, |
| OBJECT_STRING, CLASS_STRING, INTERFACE_TYPE); |
| } |
| |
| /** |
| * Returns implementation of get YANG augment info. |
| * |
| * @return implementation of get YANG augment info |
| */ |
| static String getYangAugmentInfoImpl() { |
| return getOverRideString() + |
| methodSignature(YANG_AUGMENTED_INFO_LOWER_CASE, EMPTY_STRING, |
| PUBLIC, CLASS + OBJECT_STRING, OBJECT_STRING, |
| CLASS_STRING, CLASS_TYPE) + |
| methodBody(AUGMENTED_MAP_GET_VALUE, null, null, |
| EIGHT_SPACE_INDENTATION, null, null, false) + |
| methodClose(FOUR_SPACE); |
| } |
| |
| /** |
| * Returns implementation of get YANG augment info. |
| * |
| * @return implementation of get YANG augment info |
| */ |
| static String getYangAugmentInfoMapInterface() { |
| return NEW_LINE + |
| getJavaDoc(GETTER_METHOD, YANG_AUGMENTED_INFO_LOWER_CASE + MAP, |
| false, null) + |
| methodSignature(YANG_AUGMENTED_INFO_LOWER_CASE + MAP, |
| EMPTY_STRING, null, null, |
| getAugmentMapTypeString(), null, INTERFACE_TYPE); |
| } |
| |
| /** |
| * Returns implementation of get YANG augment info. |
| * |
| * @return implementation of get YANG augment info |
| */ |
| static String getYangAugmentInfoMapImpl() { |
| return getOverRideString() + methodSignature( |
| YANG_AUGMENTED_INFO_LOWER_CASE + MAP, EMPTY_STRING, PUBLIC, null, |
| getAugmentMapTypeString(), null, CLASS_TYPE) + |
| methodBody(AUGMENTED_MAP_GETTER, null, null, |
| EIGHT_SPACE_INDENTATION, null, null, false) + |
| methodClose(FOUR_SPACE); |
| } |
| |
| /** |
| * Returns enum's constructor. |
| * |
| * @param className enum's class name |
| * @return enum's constructor |
| */ |
| static String getEnumsConstructor(String className) { |
| StringBuilder builder = new StringBuilder(); |
| String clsName = getSmallCase(className); |
| LinkedHashMap<String, String> map = new LinkedHashMap<>(); |
| map.put(INT, clsName); |
| map.put(STRING_DATA_TYPE, SCHEMA_NAME); |
| builder.append(multiAttrMethodSignature(className, EMPTY_STRING, |
| EMPTY_STRING, null, |
| map, CLASS_TYPE)) |
| .append(methodBody(SETTER, clsName, EMPTY_STRING, |
| EIGHT_SPACE_INDENTATION, EMPTY_STRING, |
| EMPTY_STRING, false)) |
| .append(methodBody(SETTER, SCHEMA_NAME, EMPTY_STRING, |
| EIGHT_SPACE_INDENTATION, EMPTY_STRING, |
| EMPTY_STRING, false)) |
| .append(methodClose(FOUR_SPACE)); |
| |
| return builder.toString(); |
| } |
| |
| /** |
| * Returns of method for enum class. |
| * |
| * @param className class name |
| * @param type method body type |
| * @return of method |
| */ |
| static String getEnumsOfValueMethod(String className, |
| YangEnumeration enumeration, |
| MethodBodyTypes type) { |
| String name = getCapitalCase(className); |
| StringBuilder builder = new StringBuilder(getJavaDoc( |
| OF_METHOD, name + SPACE + FOR, |
| false, null)); |
| //Switch statement. |
| String sw = EIGHT_SPACE_INDENTATION + SWITCH + SPACE + brackets( |
| OPEN_CLOSE_BRACKET_WITH_VALUE, VALUE, null) + |
| methodSignatureClose(CLASS_TYPE); |
| String str; |
| switch (type) { |
| case ENUM_METHOD_INT_VALUE: |
| builder.append(getEnumValueMethodSignature(name, INT)) |
| .append(sw); |
| for (YangEnum yangEnum : enumeration.getEnumSet()) { |
| str = getEnumJavaAttribute(yangEnum.getNamedValue()) |
| .toUpperCase(); |
| builder.append(getEnumValueMethodCases( |
| EMPTY_STRING + yangEnum.getValue(), str, name)); |
| } |
| break; |
| case ENUM_METHOD_STRING_VALUE: |
| builder.append(getEnumValueMethodSignature(name, |
| STRING_DATA_TYPE)) |
| .append(sw); |
| for (YangEnum yangEnum : enumeration.getEnumSet()) { |
| str = getEnumJavaAttribute(yangEnum.getNamedValue()) |
| .toUpperCase(); |
| builder.append(getEnumValueMethodCases( |
| QUOTES + yangEnum.getNamedValue() + QUOTES, str, |
| name)); |
| } |
| break; |
| default: |
| return null; |
| } |
| |
| String method = TWELVE_SPACE_INDENTATION + DEFAULT + SPACE + COLON + |
| NEW_LINE; |
| builder.append(method) |
| .append(getReturnString(NULL, SIXTEEN_SPACE_INDENTATION)) |
| .append(signatureClose()) |
| .append(methodClose(EIGHT_SPACE)) |
| .append(methodClose(FOUR_SPACE)); |
| |
| return builder.toString(); |
| } |
| |
| /** |
| * Returns enum value method signature. |
| * |
| * @param name method name |
| * @param type param type |
| * @return enum value method signature |
| */ |
| private static String getEnumValueMethodSignature(String name, String type) { |
| return methodSignature(OF, EMPTY_STRING, PUBLIC + SPACE + |
| STATIC, VALUE, name, type, CLASS_TYPE); |
| } |
| |
| /** |
| * Returns enum value method's cases. |
| * |
| * @param caseType case type |
| * @param value return value |
| * @param name name of class |
| * @return enum value method's cases |
| */ |
| private static String getEnumValueMethodCases(String caseType, String value, |
| String name) { |
| return TWELVE_SPACE_INDENTATION + CASE + SPACE + caseType + |
| COLON + NEW_LINE + getReturnString(name, |
| SIXTEEN_SPACE_INDENTATION) + |
| PERIOD + value + signatureClose(); |
| } |
| |
| /** |
| * Returns augmented data getter and setter methods for service class. |
| * |
| * @param parent parent node |
| * @return augmented data getter and setter methods for service class |
| */ |
| static String getAugmentsDataMethodForService(YangNode parent) { |
| List<YangAtomicPath> targets = getSetOfNodeIdentifiers(parent); |
| YangNode augmentedNode; |
| String curNodeName; |
| String method; |
| StringBuilder methods = new StringBuilder(); |
| String parentName; |
| String returnType; |
| YangNode methodNode; |
| YangPluginConfig pluginConfig = |
| ((JavaFileInfoContainer) parent).getJavaFileInfo() |
| .getPluginConfig(); |
| for (YangAtomicPath nodeId : targets) { |
| augmentedNode = nodeId.getResolvedNode().getParent(); |
| methodNode = nodeId.getResolvedNode(); |
| if (((JavaFileInfoContainer) methodNode).getJavaFileInfo() |
| .getJavaName() != null) { |
| curNodeName = |
| ((JavaFileInfoContainer) methodNode).getJavaFileInfo() |
| .getJavaName(); |
| } else { |
| curNodeName = getCapitalCase( |
| getCamelCase(methodNode.getName(), |
| pluginConfig.getConflictResolver())); |
| } |
| returnType = |
| getAugmentedClassNameForDataMethods(augmentedNode, parent); |
| parentName = getCurNodeName(augmentedNode, |
| pluginConfig); |
| method = generateForGetMethodWithAttribute(returnType) + |
| getGetMethodWithArgument(returnType, AUGMENTED + |
| parentName + getCapitalCase(curNodeName)) + NEW_LINE; |
| methods.append(method); |
| |
| method = getJavaDoc(MANAGER_SETTER_METHOD, |
| AUGMENTED + getCapitalCase(parentName) + |
| getCapitalCase(curNodeName), false, |
| null) + |
| getSetterForInterface(getSmallCase(AUGMENTED) + parentName + |
| getCapitalCase(curNodeName), |
| returnType, parentName, false, |
| GENERATE_SERVICE_AND_MANAGER, null) + |
| NEW_LINE; |
| methods.append(method); |
| } |
| return methods.toString(); |
| } |
| |
| /** |
| * Returns validator method for range in union class. |
| * |
| * @param type type |
| * @return validator method for range in union class |
| */ |
| static String getRangeValidatorMethodForUnion(String type) { |
| String newType; |
| if (type.contentEquals(BIG_INTEGER)) { |
| newType = LONG; |
| } else { |
| newType = INT; |
| } |
| StringBuilder builder = new StringBuilder(generateForValidatorMethod()); |
| String var = getSmallCase(BIG_INTEGER); |
| LinkedHashMap<String, String> map = new LinkedHashMap<>(); |
| map.put(MIN_RANGE, type); |
| map.put(MAX_RANGE, type); |
| map.put(VALUE, newType); |
| builder.append(multiAttrMethodSignature(VALIDATE_RANGE, EMPTY_STRING, |
| PRIVATE, BOOLEAN_DATA_TYPE, map, |
| CLASS_TYPE)); |
| if (type.contentEquals(BIG_INTEGER)) { |
| //Create new instance of big integer. |
| builder.append(getNewInstance(BIG_INTEGER, var, EIGHT_SPACE_INDENTATION, |
| QUOTES + SPACE + QUOTES + SPACE + |
| ADD + SPACE + VALUE)) |
| //Add return string. |
| .append(getReturnString(var, EIGHT_SPACE_INDENTATION)) |
| //Add compareTo string |
| .append(getCompareToString()) |
| //Add && condition. |
| .append(ifAndAndCondition( |
| //Add == condition |
| ifEqualEqualCondition( |
| brackets(OPEN_CLOSE_BRACKET_WITH_VALUE, |
| MIN_RANGE, null), ONE), |
| var)) |
| //Add compareTo string. |
| .append(getCompareToString()) |
| //Add == condition. |
| .append(ifEqualEqualCondition( |
| brackets(OPEN_CLOSE_BRACKET_WITH_VALUE, |
| MAX_RANGE, null), ONE)) |
| .append(signatureClose()); |
| } else { |
| builder.append(getReturnString(VALUE, EIGHT_SPACE_INDENTATION)) |
| .append(getGreaterThanCondition()) |
| .append(ifAndAndCondition(MIN_RANGE, VALUE)) |
| .append(getLesserThanCondition()) |
| .append(MAX_RANGE) |
| .append(signatureClose()); |
| } |
| builder.append(methodClose(FOUR_SPACE)); |
| return builder.toString(); |
| } |
| |
| //Get method with arguments. |
| private static String getGetMethodWithArgument(String returnType, |
| String yangName) { |
| return methodSignature(getCapitalCase(yangName), GET_METHOD_PREFIX, |
| null, getSmallCase(returnType), |
| returnType, returnType + OP_PARAM, |
| INTERFACE_TYPE); |
| } |
| |
| /** |
| * Returns add to list method interface. |
| * |
| * @param attr java attribute |
| * @param className name of the class |
| * @return add to list method interface |
| */ |
| public static String getAddToListMethodInterface(JavaAttributeInfo attr, |
| String className) { |
| |
| return methodSignature(ADD_STRING + TO_CAPS + getCapitalCase( |
| attr.getAttributeName()), EMPTY_STRING, EMPTY_STRING, |
| ADD_STRING + TO_CAPS, |
| className + BUILDER, getReturnType(attr), |
| INTERFACE_TYPE); |
| } |
| |
| /** |
| * Returns add to list method impl. |
| * |
| * @param attr java attribute |
| * @param name class name |
| * @param isRoot is root |
| * @return add to list method impl |
| */ |
| public static String getAddToListMethodImpl(JavaAttributeInfo attr, |
| String name, |
| boolean isRoot) { |
| String attrName = attr.getAttributeName(); |
| String retString = ""; |
| if (!isRoot) { |
| retString = getOverRideString(); |
| } |
| StringBuilder builder = new StringBuilder(retString); |
| builder.append(methodSignature(ADD_STRING + TO_CAPS + |
| getCapitalCase(attrName), |
| EMPTY_STRING, PUBLIC, ADD_STRING + TO_CAPS, |
| name + BUILDER, getReturnType(attr), |
| CLASS_TYPE)) |
| .append(getIfConditionForAddToListMethod(attrName)); |
| retString = EIGHT_SPACE_INDENTATION + attrName + PERIOD + ADD_STRING + |
| OPEN_PARENTHESIS + ADD_STRING + TO_CAPS + CLOSE_PARENTHESIS; |
| builder.append(retString) |
| .append(signatureClose()) |
| .append(getReturnString(THIS, EIGHT_SPACE_INDENTATION)) |
| .append(signatureClose()) |
| .append(methodClose(FOUR_SPACE)); |
| return builder.toString(); |
| } |
| |
| // Returns if condition for add to list method. |
| static String getIfConditionForAddToListMethod(String name) { |
| return getIfConditionBegin(EIGHT_SPACE_INDENTATION, name + SPACE + EQUAL + |
| EQUAL + SPACE + NULL) + TWELVE_SPACE_INDENTATION + |
| name + SPACE + EQUAL + SPACE + |
| NEW + SPACE + ARRAY_LIST + signatureClose() + methodClose( |
| EIGHT_SPACE); |
| } |
| |
| /** |
| * Returns builder method for class. |
| * |
| * @param name name of class |
| * @return builder method for class |
| */ |
| static String builderMethod(String name) { |
| return generateForBuilderMethod(name) + |
| methodSignature(BUILDER_LOWER_CASE, |
| EMPTY_STRING, PUBLIC + SPACE + |
| STATIC, null, name + BUILDER, null, CLASS_TYPE) + |
| getReturnString(NEW + SPACE + name + BUILDER, |
| EIGHT_SPACE_INDENTATION) + |
| brackets(OPEN_CLOSE_BRACKET, null, null) + signatureClose() + |
| methodClose(FOUR_SPACE); |
| } |
| |
| /** |
| * Returns is filter content match interface. |
| * |
| * @param name name of node |
| * @return is filter content match interface |
| */ |
| static String processSubtreeFilteringInterface(String name) { |
| String method = " /**\n" + |
| " * Checks if the passed " + name + |
| " maps the content match query condition.\n" + |
| " *\n" + |
| " * @param " + getSmallCase(name) + SPACE + |
| getSmallCase(name) + SPACE + "being passed to check" + |
| " for" + |
| " content match\n" + |
| " * @param isSelectAllSchemaChild is select all schema child\n" + |
| " * @return match result\n" + |
| " */\n"; |
| LinkedHashMap<String, String> map = new LinkedHashMap<>(); |
| map.put(name, getSmallCase(name)); |
| map.put(BOOLEAN_DATA_TYPE, SELECT_ALL_CHILD); |
| |
| return method + multiAttrMethodSignature(PROCESS_SUBTREE_FILTERING, |
| EMPTY_STRING, EMPTY_STRING, |
| name, map, INTERFACE_TYPE); |
| } |
| |
| /** |
| * Returns is value set interface. |
| * |
| * @return is value set interface |
| */ |
| static String isLeafValueSetInterface() { |
| String method = "\n /**\n" + |
| " * Checks if the leaf value is set.\n" + |
| " *\n" + |
| " * @param leaf leaf whose value status needs to checked\n" + |
| " * @return result of leaf value set in object\n" + |
| " */\n"; |
| return method + methodSignature(VALUE_LEAF_SET, EMPTY_STRING, null, |
| LEAF, BOOLEAN_DATA_TYPE, |
| LEAF_IDENTIFIER, INTERFACE_TYPE); |
| } |
| |
| /** |
| * Returns is select leaf set interface. |
| * |
| * @return is select leaf set interface |
| */ |
| static String isSelectLeafSetInterface() { |
| String method = "\n /**\n" + |
| " * Checks if the leaf is set to be a selected leaf.\n" + |
| " *\n" + |
| " * @param leaf if leaf needs to be selected\n" + |
| " * @return result of leaf value set in object\n" + |
| " */\n"; |
| return method + methodSignature(IS_SELECT_LEAF, EMPTY_STRING, null, |
| LEAF, BOOLEAN_DATA_TYPE, LEAF_IDENTIFIER, |
| INTERFACE_TYPE); |
| } |
| |
| /** |
| * Returns set select leaf set interface. |
| * |
| * @param name node name |
| * @return set select leaf set interface |
| */ |
| static String setSelectLeafSetInterface(String name) { |
| String method = " /**\n" + |
| " * Set a leaf to be selected.\n" + |
| " *\n" + |
| " * @param leaf leaf needs to be selected\n" + |
| " * @return builder object for select leaf\n" + |
| " */\n"; |
| return method + methodSignature(SET_SELECT_LEAF, EMPTY_STRING, |
| null, LEAF, name + |
| BUILDER, LEAF_IDENTIFIER, |
| INTERFACE_TYPE) + NEW_LINE; |
| } |
| |
| /** |
| * Returns leaf identifier interface enum signature. |
| * |
| * @param name name of node |
| * @return leaf identifier interface enum signature |
| */ |
| static String getInterfaceLeafIdEnumSignature(String name) { |
| String start = "\n /**\n" + |
| " * Identify the leaf of " + name + PERIOD + NEW_LINE + |
| " */\n"; |
| return start + FOUR_SPACE_INDENTATION + PUBLIC + SPACE + ENUM + SPACE + |
| LEAF_IDENTIFIER + SPACE + OPEN_CURLY_BRACKET + NEW_LINE; |
| } |
| |
| /** |
| * Returns setter for select leaf. |
| * |
| * @param name name of node |
| * @param isRootNode if root node |
| * @return setter for select leaf |
| */ |
| static String getSetterForSelectLeaf(String name, boolean isRootNode) { |
| String append = OVERRIDE; |
| if (isRootNode) { |
| append = EMPTY_STRING; |
| } |
| return "\n" + |
| " " + append + "\n" + |
| " public " + name + BUILDER + |
| " selectLeaf(LeafIdentifier leaf) {\n" + |
| " getSelectLeafFlags().set(leaf.getLeafIndex());\n" + |
| " return this;\n" + |
| " }\n"; |
| } |
| |
| /** |
| * Generates fromString code for bits. |
| * |
| * @param attr attribute information |
| * @param yangBits parsed yang bits |
| * @return generated fromString code for bits. |
| */ |
| private static String getFromStringForBits(JavaAttributeInfo attr, YangBits yangBits) { |
| String targetDataType = getReturnType(attr); |
| String key; |
| YangBit bit; |
| // Split the input string and check each bit name falls in configured yang file |
| String lines = targetDataType + SPACE + TMP_VAL + SPACE + EQUAL + SPACE + NEW + SPACE + targetDataType + |
| OPEN_PARENTHESIS + CLOSE_PARENTHESIS + SEMI_COLON + NEW_LINE + |
| TWELVE_SPACE_INDENTATION + STRING_DATA_TYPE + SQUARE_BRACKETS + SPACE + BIT_NAMES_VAR + SPACE + |
| EQUAL + SPACE + FROM_STRING_PARAM_NAME + PERIOD + TRIM_STRING + EMPTY_PARAMETER_FUNCTION_CALL + |
| PERIOD + SPLIT_STRING + OPEN_PARENTHESIS + PATTERN + PERIOD + QUOTE_STRING + |
| OPEN_PARENTHESIS + QUOTES + SPACE + QUOTES + CLOSE_PARENTHESIS + CLOSE_PARENTHESIS + SEMI_COLON + |
| NEW_LINE + |
| TWELVE_SPACE_INDENTATION + FOR + SPACE + OPEN_PARENTHESIS + STRING_DATA_TYPE + SPACE + BIT_NAME_VAR + |
| SPACE + COLON + SPACE + BIT_NAMES_VAR + CLOSE_PARENTHESIS + SPACE + OPEN_CURLY_BRACKET + NEW_LINE; |
| boolean firstIf = true; |
| String ifCondition = IF; |
| for (Map.Entry<String, YangBit> entry : yangBits.getBitNameMap().entrySet()) { |
| key = entry.getKey(); |
| bit = entry.getValue(); |
| if (bit == null) { |
| return null; |
| } |
| if (firstIf) { |
| lines += SIXTEEN_SPACE_INDENTATION; |
| } |
| // Add condition checking for bit name |
| lines += ifCondition + SPACE + OPEN_PARENTHESIS + BIT_NAME_VAR + PERIOD + |
| EQUALS_STRING + OPEN_PARENTHESIS + QUOTES + key + QUOTES + CLOSE_PARENTHESIS + CLOSE_PARENTHESIS + |
| SPACE + OPEN_CURLY_BRACKET + NEW_LINE + |
| TWENTY_SPACE_INDENTATION + TMP_VAL + PERIOD + SET_METHOD_PREFIX + OPEN_PARENTHESIS + |
| bit.getPosition() + CLOSE_PARENTHESIS + SEMI_COLON + NEW_LINE + SIXTEEN_SPACE_INDENTATION + |
| CLOSE_CURLY_BRACKET; |
| if (firstIf) { |
| ifCondition = SPACE + ELSE_IF; |
| firstIf = false; |
| } |
| } |
| |
| if (!firstIf) { |
| // This means at least one if condition is added in code generation |
| // Now add else condition for validation |
| lines += SPACE + ELSE + SPACE + OPEN_CURLY_BRACKET + NEW_LINE + TWENTY_SPACE_INDENTATION + RETURN + |
| SPACE + NULL + SEMI_COLON + NEW_LINE + SIXTEEN_SPACE_INDENTATION + CLOSE_CURLY_BRACKET; |
| } |
| |
| lines += NEW_LINE + TWELVE_SPACE_INDENTATION + CLOSE_CURLY_BRACKET + NEW_LINE; |
| return lines; |
| } |
| } |