Gaurav Agrawal | 1fbfae1 | 2016-03-29 02:17:23 +0530 | [diff] [blame] | 1 | /* |
Brian O'Connor | 0f7908b | 2016-04-09 01:19:45 -0700 | [diff] [blame^] | 2 | * Copyright 2016-present Open Networking Laboratory |
Gaurav Agrawal | 1fbfae1 | 2016-03-29 02:17:23 +0530 | [diff] [blame] | 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.datamodel; |
| 18 | |
| 19 | import java.util.List; |
| 20 | import org.onosproject.yangutils.datamodel.exceptions.DataModelException; |
| 21 | |
| 22 | /** |
| 23 | * Abstraction of YANG dependency resolution information. Abstracted to obtain the |
| 24 | * resolution information. |
| 25 | */ |
| 26 | public interface HasResolutionInfo { |
| 27 | |
| 28 | /** |
| 29 | * Returns unresolved resolution list. |
| 30 | * |
| 31 | * @return unresolved resolution list |
| 32 | */ |
| 33 | List<YangResolutionInfo> getUnresolvedResolutionList(); |
| 34 | |
| 35 | /** |
| 36 | * Add to the resolution list. |
| 37 | * |
| 38 | * @param resolutionInfo resolution information |
| 39 | */ |
| 40 | void addToResolutionList(YangResolutionInfo resolutionInfo); |
| 41 | |
| 42 | /** |
| 43 | * Creates resolution list. |
| 44 | * |
| 45 | * @param resolutionList resolution list |
| 46 | */ |
| 47 | void setResolutionList(List<YangResolutionInfo> resolutionList); |
| 48 | |
| 49 | /** |
| 50 | * Returns unresolved imported list. |
| 51 | * |
| 52 | * @return unresolved imported list |
| 53 | */ |
| 54 | List<YangImport> getImportList(); |
| 55 | |
| 56 | /** |
| 57 | * Add to the import list. |
| 58 | * |
| 59 | * @param yangImport import to be added |
| 60 | */ |
| 61 | void addToImportList(YangImport yangImport); |
| 62 | |
| 63 | /** |
| 64 | * Create import list. |
| 65 | * |
| 66 | * @param importList import list |
| 67 | */ |
| 68 | void setImportList(List<YangImport> importList); |
| 69 | |
| 70 | /** |
| 71 | * Returns unresolved include list. |
| 72 | * |
| 73 | * @return unresolved include list |
| 74 | */ |
| 75 | List<YangInclude> getIncludeList(); |
| 76 | |
| 77 | /** |
| 78 | * Add to the include list. |
| 79 | * |
| 80 | * @param yangInclude include to be added |
| 81 | */ |
| 82 | void addToIncludeList(YangInclude yangInclude); |
| 83 | |
| 84 | /** |
| 85 | * Create include list. |
| 86 | * |
| 87 | * @param includeList include list |
| 88 | */ |
| 89 | void setIncludeList(List<YangInclude> includeList); |
| 90 | |
| 91 | /** |
| 92 | * Returns prefix of resolution root node. |
| 93 | * |
| 94 | * @return prefix resolution root node prefix |
| 95 | */ |
| 96 | String getPrefix(); |
| 97 | |
| 98 | /** |
| 99 | * Set prefix of resolution list root node. |
| 100 | * |
| 101 | * @param prefix resolution root node prefix |
| 102 | */ |
| 103 | void setPrefix(String prefix); |
| 104 | |
| 105 | /** |
| 106 | * Resolve self file linking. |
| 107 | * |
| 108 | * @throws DataModelException a violation in data model rule |
| 109 | */ |
| 110 | void resolveSelfFileLinking() throws DataModelException; |
| 111 | } |