Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2016 Open Networking Laboratory |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package org.onosproject.yangutils.translator.tojava.utils; |
| 18 | |
| 19 | import java.util.ArrayList; |
| 20 | |
| 21 | import org.onosproject.yangutils.utils.UtilConstants; |
| 22 | |
| 23 | /** |
| 24 | * Utility Class for translating the name from YANG to java convention. |
| 25 | */ |
| 26 | public final class JavaIdentifierSyntax { |
| 27 | |
| 28 | /** |
| 29 | * Util class, with static functions only. |
| 30 | */ |
| 31 | private JavaIdentifierSyntax() { |
| 32 | } |
| 33 | |
| 34 | /** |
| 35 | * Get the root package string. |
| 36 | * |
| 37 | * @param version YANG version. |
| 38 | * @param nameSpace name space of the module. |
| 39 | * @param revision revision of the module defined |
| 40 | * @return returns the root package string. |
| 41 | */ |
| 42 | public static String getRootPackage(byte version, String nameSpace, String revision) { |
| 43 | |
| 44 | String pkg; |
| 45 | pkg = UtilConstants.DEFAULT_BASE_PKG; |
| 46 | pkg = pkg + UtilConstants.PERIOD; |
| 47 | pkg = pkg + getYangVersion(version); |
| 48 | pkg = pkg + UtilConstants.PERIOD; |
| 49 | pkg = pkg + getPkgFromNameSpace(nameSpace); |
| 50 | pkg = pkg + UtilConstants.PERIOD; |
| 51 | pkg = pkg + getYangRevisionStr(revision); |
| 52 | |
| 53 | return pkg; |
| 54 | } |
| 55 | |
| 56 | /** |
| 57 | * Returns version. |
| 58 | * |
| 59 | * @param ver YANG version. |
| 60 | * @return version |
| 61 | */ |
| 62 | private static String getYangVersion(byte ver) { |
| 63 | return "v" + ver; |
| 64 | } |
| 65 | |
| 66 | /** |
| 67 | * Get package name from name space. |
| 68 | * |
| 69 | * @param nameSpace name space of YANG module |
| 70 | * @return java package name as per java rules. |
| 71 | */ |
| 72 | public static String getPkgFromNameSpace(String nameSpace) { |
| 73 | ArrayList<String> pkgArr = new ArrayList<String>(); |
| 74 | nameSpace = nameSpace.replace("\"", ""); |
| 75 | |
| 76 | String[] nameSpaceArr = nameSpace.split(UtilConstants.COLAN); |
| 77 | |
| 78 | for (String nameSpaceString : nameSpaceArr) { |
| 79 | pkgArr.add(nameSpaceString); |
| 80 | } |
| 81 | return getPkgFrmArr(pkgArr); |
| 82 | } |
| 83 | |
| 84 | /** |
| 85 | * Returns revision string array. |
| 86 | * |
| 87 | * @param date YANG module revision |
| 88 | * @return revision string |
| 89 | */ |
| 90 | public static String getYangRevisionStr(String date) { |
| 91 | String[] revisionArr = date.split(UtilConstants.HYPHEN); |
| 92 | |
| 93 | String rev = "rev"; |
| 94 | for (String element : revisionArr) { |
| 95 | Integer val = Integer.parseInt(element); |
| 96 | if (val < 10) { |
| 97 | rev = rev + "0"; |
| 98 | } |
| 99 | rev = rev + val; |
| 100 | } |
| 101 | return rev; |
| 102 | } |
| 103 | |
| 104 | /** |
| 105 | * Returns the package string. |
| 106 | * |
| 107 | * @param pkgArr package array |
| 108 | * @return package string |
| 109 | */ |
| 110 | public static String getPkgFrmArr(ArrayList<String> pkgArr) { |
| 111 | |
| 112 | String pkg = ""; |
| 113 | int size = pkgArr.size(); |
| 114 | int i = 0; |
| 115 | for (String member : pkgArr) { |
| 116 | pkg = pkg + member; |
| 117 | if (i != size - 1) { |
| 118 | pkg = pkg + UtilConstants.PERIOD; |
| 119 | } |
| 120 | i++; |
| 121 | } |
| 122 | return pkg; |
| 123 | } |
| 124 | |
| 125 | /** |
| 126 | * Get the package from parent's package and string. |
| 127 | * |
| 128 | * @param parentPkg parent's package. |
| 129 | * @param childName child's name. |
| 130 | * @return package string. |
| 131 | */ |
| 132 | public static String getPackageFromParent(String parentPkg, String childName) { |
| 133 | return parentPkg + UtilConstants.PERIOD + getSubPkgFromName(childName); |
| 134 | } |
| 135 | |
| 136 | /** |
| 137 | * Get package sub name from YANG identifier name. |
| 138 | * |
| 139 | * @param name YANG identifier name. |
| 140 | * @return java package sub name as per java rules. |
| 141 | */ |
| 142 | public static String getSubPkgFromName(String name) { |
| 143 | ArrayList<String> pkgArr = new ArrayList<String>(); |
| 144 | String[] nameArr = name.split(UtilConstants.COLAN); |
| 145 | |
| 146 | for (String nameString : nameArr) { |
| 147 | pkgArr.add(nameString); |
| 148 | } |
| 149 | return getPkgFrmArr(pkgArr); |
| 150 | } |
| 151 | |
| 152 | /** |
| 153 | * Translate the YANG identifier name to java identifier. |
| 154 | * |
| 155 | * @param yangIdentifier identifier in YANG file. |
| 156 | * @return corresponding java identifier |
| 157 | */ |
| 158 | public static String getCamelCase(String yangIdentifier) { |
| 159 | String[] strArray = yangIdentifier.split(UtilConstants.HYPHEN); |
| 160 | String camelCase = strArray[0]; |
| 161 | for (int i = 1; i < strArray.length; i++) { |
| 162 | camelCase = camelCase + (strArray[i].substring(0, 1).toUpperCase() + strArray[i].substring(1)); |
| 163 | } |
| 164 | return camelCase; |
| 165 | } |
Bharat saraswal | 5e3c45c | 2016-02-22 22:15:21 +0530 | [diff] [blame] | 166 | |
| 167 | /** |
| 168 | * Translate the YANG identifier name to java identifier with first letter in caps. |
| 169 | * |
| 170 | * @param yangIdentifier identifier in YANG file. |
| 171 | * @return corresponding java identifier |
| 172 | */ |
| 173 | public static String getCaptialCase(String yangIdentifier) { |
| 174 | return yangIdentifier.substring(0, 1).toUpperCase() + yangIdentifier.substring(1); |
| 175 | } |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 176 | } |