Gaurav Agrawal | f576642 | 2016-03-23 19:04:17 +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 | f576642 | 2016-03-23 19:04:17 +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.LinkedList; |
| 20 | import java.util.List; |
Bharat saraswal | 63f26fb | 2016-04-05 15:13:44 +0530 | [diff] [blame^] | 21 | |
Gaurav Agrawal | f576642 | 2016-03-23 19:04:17 +0530 | [diff] [blame] | 22 | import org.onosproject.yangutils.datamodel.exceptions.DataModelException; |
| 23 | import org.onosproject.yangutils.parser.Parsable; |
| 24 | import org.onosproject.yangutils.utils.YangConstructType; |
| 25 | |
| 26 | import static org.onosproject.yangutils.datamodel.utils.DataModelUtils.detectCollidingChildUtil; |
| 27 | |
| 28 | /* |
| 29 | * Reference RFC 6020. |
| 30 | * |
| 31 | * The "output" statement, which is optional, is used to define output |
| 32 | * parameters to the RPC operation. It does not take an argument. The |
| 33 | * substatements to "output" define nodes under the RPC's output node. |
| 34 | * |
| 35 | * If a leaf in the output tree has a "mandatory" statement with the |
| 36 | * value "true", the leaf MUST be present in a NETCONF RPC reply. |
| 37 | * |
| 38 | * If a leaf in the output tree has a default value, the NETCONF client |
| 39 | * MUST use this value in the same cases as described in Section 7.6.1. |
| 40 | * In these cases, the client MUST operationally behave as if the leaf |
| 41 | * was present in the NETCONF RPC reply with the default value as its |
| 42 | * value. |
| 43 | * |
| 44 | * If a "config" statement is present for any node in the output tree, |
| 45 | * the "config" statement is ignored. |
| 46 | * |
| 47 | * If any node has a "when" statement that would evaluate to false, then |
| 48 | * this node MUST NOT be present in the output tree. |
| 49 | * |
| 50 | * The output substatements |
| 51 | * |
| 52 | * +--------------+---------+-------------+------------------+ |
| 53 | * | substatement | section | cardinality |data model mapping| |
| 54 | * +--------------+---------+-------------+------------------+ |
| 55 | * | anyxml | 7.10 | 0..n | -not supported | |
| 56 | * | choice | 7.9 | 0..n | -child nodes | |
| 57 | * | container | 7.5 | 0..n | -child nodes | |
| 58 | * | grouping | 7.11 | 0..n | -child nodes | |
| 59 | * | leaf | 7.6 | 0..n | -YangLeaf | |
| 60 | * | leaf-list | 7.7 | 0..n | -YangLeafList | |
| 61 | * | list | 7.8 | 0..n | -child nodes | |
| 62 | * | typedef | 7.3 | 0..n | -child nodes | |
| 63 | * | uses | 7.12 | 0..n | -child nodes | |
| 64 | * +--------------+---------+-------------+------------------+ |
| 65 | */ |
| 66 | |
| 67 | /** |
Bharat saraswal | 63f26fb | 2016-04-05 15:13:44 +0530 | [diff] [blame^] | 68 | * Represents data model node to maintain information defined in YANG output. |
Gaurav Agrawal | f576642 | 2016-03-23 19:04:17 +0530 | [diff] [blame] | 69 | */ |
| 70 | public class YangOutput extends YangNode implements YangLeavesHolder, Parsable, CollisionDetector { |
| 71 | |
| 72 | /** |
| 73 | * Name of the output. |
| 74 | */ |
| 75 | private String name; |
| 76 | |
| 77 | /** |
| 78 | * List of leaves contained. |
| 79 | */ |
| 80 | private List<YangLeaf> listOfLeaf; |
| 81 | |
| 82 | /** |
| 83 | * List of leaf-lists contained. |
| 84 | */ |
| 85 | private List<YangLeafList> listOfLeafList; |
| 86 | |
| 87 | /** |
| 88 | * Create a rpc output node. |
| 89 | */ |
| 90 | public YangOutput() { |
| 91 | super(YangNodeType.OUTPUT_NODE); |
| 92 | listOfLeaf = new LinkedList<YangLeaf>(); |
| 93 | listOfLeafList = new LinkedList<YangLeafList>(); |
| 94 | } |
| 95 | |
| 96 | @Override |
| 97 | public void detectCollidingChild(String identifierName, YangConstructType dataType) throws DataModelException { |
| 98 | // Detect colliding child. |
| 99 | detectCollidingChildUtil(identifierName, dataType, this); |
| 100 | } |
| 101 | |
| 102 | @Override |
| 103 | public void detectSelfCollision(String identifierName, YangConstructType dataType) throws DataModelException { |
| 104 | if (this.getName().equals(identifierName)) { |
| 105 | throw new DataModelException("YANG file error: Duplicate identifier detected, same as output \"" |
| 106 | + this.getName() + "\""); |
| 107 | } |
| 108 | } |
| 109 | |
| 110 | @Override |
| 111 | public YangConstructType getYangConstructType() { |
| 112 | return YangConstructType.OUTPUT_DATA; |
| 113 | } |
| 114 | |
| 115 | @Override |
| 116 | public void validateDataOnEntry() throws DataModelException { |
| 117 | //TODO: implement the method. |
| 118 | } |
| 119 | |
| 120 | @Override |
| 121 | public void validateDataOnExit() throws DataModelException { |
| 122 | //TODO: implement the method. |
| 123 | } |
| 124 | |
| 125 | @Override |
| 126 | public List<YangLeaf> getListOfLeaf() { |
| 127 | return listOfLeaf; |
| 128 | } |
| 129 | |
| 130 | @Override |
| 131 | public void addLeaf(YangLeaf leaf) { |
| 132 | getListOfLeaf().add(leaf); |
| 133 | } |
| 134 | |
| 135 | @Override |
| 136 | public List<YangLeafList> getListOfLeafList() { |
| 137 | return listOfLeafList; |
| 138 | } |
| 139 | |
| 140 | @Override |
| 141 | public void addLeafList(YangLeafList leafList) { |
| 142 | getListOfLeafList().add(leafList); |
| 143 | } |
| 144 | |
| 145 | @Override |
| 146 | public String getName() { |
| 147 | return name; |
| 148 | } |
| 149 | |
| 150 | @Override |
| 151 | public void setName(String name) { |
| 152 | this.name = name; |
| 153 | } |
| 154 | } |