Bharat saraswal | e2bc60d | 2016-04-16 02:28:25 +0530 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2016-present 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.io.File; |
| 20 | import java.io.IOException; |
| 21 | import java.util.List; |
| 22 | |
| 23 | import org.onosproject.yangutils.datamodel.YangNode; |
| 24 | import org.onosproject.yangutils.translator.tojava.HasJavaImportData; |
| 25 | |
| 26 | import static org.onosproject.yangutils.translator.tojava.JavaImportData.getAugmentedInfoImport; |
| 27 | import static org.onosproject.yangutils.translator.tojava.JavaImportData.getHasAugmentationImport; |
| 28 | import static org.onosproject.yangutils.translator.tojava.JavaImportData.getImportForArrayList; |
| 29 | import static org.onosproject.yangutils.translator.tojava.JavaImportData.getImportForList; |
| 30 | import static org.onosproject.yangutils.utils.UtilConstants.AUGMENTED_INFO; |
| 31 | import static org.onosproject.yangutils.utils.UtilConstants.HAS_AUGMENTATION; |
| 32 | import static org.onosproject.yangutils.utils.io.impl.FileSystemUtil.updateFileHandle; |
| 33 | |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 34 | import static java.util.Collections.sort; |
| 35 | |
Bharat saraswal | e2bc60d | 2016-04-16 02:28:25 +0530 | [diff] [blame] | 36 | /** |
| 37 | * Represents utilities for temporary java code fragments. |
| 38 | */ |
| 39 | public final class TempJavaCodeFragmentFilesUtils { |
| 40 | |
| 41 | /** |
| 42 | * Creates a private instance of temporary java code fragment utils. |
| 43 | */ |
| 44 | private TempJavaCodeFragmentFilesUtils() { |
| 45 | } |
| 46 | |
| 47 | /** |
| 48 | * Adds imports for ToString and HashCodeMethod. |
| 49 | * |
| 50 | * @param curNode current YANG node |
| 51 | * @param imports import list |
| 52 | * @return import list |
| 53 | */ |
| 54 | public static List<String> addImportsToStringAndHasCodeMethods(YangNode curNode, List<String> imports) { |
| 55 | if (curNode instanceof HasJavaImportData) { |
| 56 | imports.add(((HasJavaImportData) curNode).getJavaImportData().getImportForHashAndEquals()); |
| 57 | imports.add(((HasJavaImportData) curNode).getJavaImportData().getImportForToString()); |
| 58 | } |
| 59 | return imports; |
| 60 | } |
| 61 | |
| 62 | /** |
| 63 | * Adds import for HasAugmentation class. |
| 64 | * |
| 65 | * @param curNode current YANG node |
| 66 | * @param imports list of imports |
| 67 | * @param operation add or delete import |
| 68 | * @return import for HasAugmentation class |
| 69 | */ |
| 70 | public static List<String> addHasAugmentationImport(YangNode curNode, List<String> imports, boolean operation) { |
| 71 | if (curNode instanceof HasJavaImportData) { |
| 72 | String thisImport = getHasAugmentationImport(); |
| 73 | performOperationOnImports(imports, thisImport, operation); |
| 74 | } |
| 75 | return imports; |
| 76 | } |
| 77 | |
| 78 | /** |
| 79 | * Adds import for AugmentedInfo class. |
| 80 | * |
| 81 | * @param curNode current YANG node |
| 82 | * @param imports list of imports |
| 83 | * @param operation add or delete import |
| 84 | * @return import for AugmentedInfo class |
| 85 | */ |
| 86 | public static List<String> addAugmentedInfoImport(YangNode curNode, List<String> imports, boolean operation) { |
| 87 | if (curNode instanceof HasJavaImportData) { |
| 88 | String thisImport = getAugmentedInfoImport(); |
| 89 | performOperationOnImports(imports, thisImport, operation); |
| 90 | } |
| 91 | return imports; |
| 92 | } |
| 93 | |
| 94 | /** |
| 95 | * Adds import for array list. |
| 96 | * |
| 97 | * @param curNode current YANG node |
| 98 | * @param imports list of imports |
| 99 | * @param operation add or delete import |
| 100 | * @return import for HasAugmentation class |
| 101 | */ |
| 102 | public static List<String> addArrayListImport(YangNode curNode, List<String> imports, boolean operation) { |
| 103 | if (curNode instanceof HasJavaImportData) { |
| 104 | String arrayListImport = getImportForArrayList(); |
| 105 | String listImport = getImportForList(); |
| 106 | performOperationOnImports(imports, arrayListImport, operation); |
| 107 | if (!imports.contains(listImport)) { |
| 108 | /** |
| 109 | * List can be there because of attribute also , so no need to remove it and operation will |
| 110 | * always be add(true). |
| 111 | */ |
| 112 | performOperationOnImports(imports, listImport, true); |
| 113 | } |
| 114 | } |
| 115 | |
| 116 | return imports; |
| 117 | } |
| 118 | |
| 119 | /** |
| 120 | * Performs given operations on import list. |
| 121 | * |
| 122 | * @param imports list of imports |
| 123 | * @param curImport current import |
| 124 | * @param operation add or remove |
| 125 | * @return import list |
| 126 | */ |
| 127 | private static List<String> performOperationOnImports(List<String> imports, String curImport, boolean operation) { |
| 128 | if (operation) { |
| 129 | imports.add(curImport); |
| 130 | } else { |
| 131 | imports.remove(curImport); |
| 132 | } |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 133 | sort(imports); |
Bharat saraswal | e2bc60d | 2016-04-16 02:28:25 +0530 | [diff] [blame] | 134 | return imports; |
| 135 | } |
| 136 | |
| 137 | /** |
| 138 | * Prepares java file generator for extends list. |
| 139 | * |
| 140 | * @param extendsList list of classes need to be extended |
| 141 | */ |
| 142 | public static void prepareJavaFileGeneratorForExtendsList(List<String> extendsList) { |
| 143 | |
| 144 | if (!extendsList.isEmpty() && !extendsList.equals(null)) { |
| 145 | JavaFileGenerator.setExtendsList(extendsList); |
| 146 | JavaFileGenerator.setIsExtendsList(true); |
| 147 | } else { |
| 148 | JavaFileGenerator.getExtendsList().clear(); |
| 149 | JavaFileGenerator.setIsExtendsList(false); |
| 150 | } |
| 151 | } |
| 152 | |
| 153 | /** |
| 154 | * Returns true if HasAugmentation class needs to be extended. |
| 155 | * |
| 156 | * @param extendsList list of classes need to be extended |
| 157 | * @return true or false |
| 158 | */ |
| 159 | public static boolean isHasAugmentationExtended(List<String> extendsList) { |
| 160 | if (extendsList != null && extendsList.contains(HAS_AUGMENTATION)) { |
| 161 | return true; |
| 162 | } |
| 163 | return false; |
| 164 | } |
| 165 | |
| 166 | /** |
| 167 | * Returns true if AugmentedInfo class needs to be extended. |
| 168 | * |
| 169 | * @param extendsList list of classes need to be extended |
| 170 | * @return true or false |
| 171 | */ |
| 172 | public static boolean isAugmentedInfoExtended(List<String> extendsList) { |
| 173 | if (extendsList != null && extendsList.contains(AUGMENTED_INFO)) { |
| 174 | return true; |
| 175 | } |
| 176 | return false; |
| 177 | } |
| 178 | |
| 179 | /** |
| 180 | * Closes the file handle for temporary file. |
| 181 | * |
| 182 | * @param file file to be closed |
| 183 | * @param toBeDeleted flag to indicate if file needs to be deleted |
| 184 | * @throws IOException when failed to close the file handle |
| 185 | */ |
| 186 | public static void closeFile(File file, boolean toBeDeleted) throws IOException { |
| 187 | |
| 188 | if (file != null) { |
| 189 | updateFileHandle(file, null, true); |
| 190 | if (toBeDeleted) { |
| 191 | file.delete(); |
| 192 | } |
| 193 | } |
| 194 | } |
| 195 | } |