1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
|
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
* Modifications Copyright (C) 2019 Nordix Foundation.
* ================================================================================
* 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.
*
* SPDX-License-Identifier: Apache-2.0
* ============LICENSE_END=========================================================
*/
package org.onap.policy.apex.auth.clieditor;
import java.util.ArrayList;
import java.util.List;
import java.util.NavigableMap;
import java.util.Set;
import java.util.TreeMap;
import java.util.TreeSet;
import org.onap.policy.common.utils.validation.Assertions;
/**
* The Class KeywordNode holds the structure of a command keyword for the Apex CLI editor. The
* keyword itself and all its children are held as a recursive tree. This class is used to manage
* interactive sub-modes in the Apex CLI editor.
*/
public class KeywordNode implements Comparable<KeywordNode> {
private final String keyword;
private final TreeMap<String, KeywordNode> children;
private CommandLineCommand command;
/**
* This Constructor creates a keyword node with the given keyword and no command.
*
* @param keyword the keyword of the node
*/
public KeywordNode(final String keyword) {
this(keyword, null);
}
/**
* This Constructor creates a keyword node with the given keyword and command.
*
* @param keyword the keyword of the keyword node
* @param command the command associated with this keyword
*/
public KeywordNode(final String keyword, final CommandLineCommand command) {
Assertions.argumentNotNull(keyword, "commands may not be null");
this.keyword = keyword;
children = new TreeMap<>();
this.command = command;
}
/**
* Process a list of keywords on this keyword node, recursing the keyword node tree, creating
* new branches for the keyword list if required. When the end of a branch has been reached,
* store the command in that keyword node..
*
* @param keywordList the list of keywords to process on this keyword node
* @param incomingCommand the command
*/
public void processKeywords(final List<String> keywordList, final CommandLineCommand incomingCommand) {
if (keywordList.isEmpty()) {
this.command = incomingCommand;
return;
}
if (!children.containsKey(keywordList.get(0))) {
children.put(keywordList.get(0), new KeywordNode(keywordList.get(0)));
}
final ArrayList<String> nextLevelKeywordList = new ArrayList<>(keywordList);
nextLevelKeywordList.remove(0);
children.get(keywordList.get(0)).processKeywords(nextLevelKeywordList, incomingCommand);
}
/**
* Adds the system commands to the keyword node.
*
* @param systemCommandNodes the system command nodes to add to the keyword node
*/
public void addSystemCommandNodes(final Set<KeywordNode> systemCommandNodes) {
if (children.isEmpty()) {
return;
}
for (final KeywordNode node : children.values()) {
node.addSystemCommandNodes(systemCommandNodes);
}
for (final KeywordNode systemCommandNode : systemCommandNodes) {
children.put(systemCommandNode.getKeyword(), systemCommandNode);
}
}
/**
* Gets the keyword of this keyword node.
*
* @return the keyword of this keyword node
*/
public String getKeyword() {
return keyword;
}
/**
* Gets the children of this keyword node.
*
* @return the children of this keyword node
*/
public NavigableMap<String, KeywordNode> getChildren() {
return children;
}
/**
* Gets the command of this keyword node.
*
* @return the command of this keyword node
*/
public CommandLineCommand getCommand() {
return command;
}
/*
* (non-Javadoc)
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
return "CommandKeywordNode [keyword=" + keyword + ", children=" + children + ", command=" + command + "]";
}
/**
* Gets the commands.
*
* @return the commands
*/
public Set<CommandLineCommand> getCommands() {
final Set<CommandLineCommand> commandSet = new TreeSet<>();
for (final KeywordNode child : children.values()) {
if (child.getCommand() != null) {
commandSet.add(child.getCommand());
}
commandSet.addAll(child.getCommands());
}
return commandSet;
}
/*
* (non-Javadoc)
*
* @see java.lang.Comparable#compareTo(java.lang.Object)
*/
@Override
public int compareTo(final KeywordNode otherKeywordNode) {
Assertions.argumentNotNull(otherKeywordNode, "comparison object may not be null");
if (this == otherKeywordNode) {
return 0;
}
if (getClass() != otherKeywordNode.getClass()) {
return this.hashCode() - otherKeywordNode.hashCode();
}
final KeywordNode other = otherKeywordNode;
if (!keyword.equals(other.keyword)) {
return keyword.compareTo(other.keyword);
}
if (!children.equals(other.children)) {
return (children.hashCode() - other.children.hashCode());
}
return command.compareTo(otherKeywordNode.command);
}
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + ((children == null) ? 0 : children.hashCode());
result = prime * result + ((command == null) ? 0 : command.hashCode());
result = prime * result + ((keyword == null) ? 0 : keyword.hashCode());
return result;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
return this.compareTo((KeywordNode) obj) == 0;
}
}
|