1 /*
2 * Copyright 2020-2022 Foreseeti AB <https://foreseeti.com>
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.mal_lang.langspec;
18
19 import static java.util.Objects.requireNonNull;
20
21 import jakarta.json.Json;
22 import jakarta.json.JsonObject;
23 import java.util.Map;
24 import org.mal_lang.langspec.builders.MetaBuilder;
25
26 /**
27 * Immutable class representing meta info of {@link org.mal_lang.langspec.Category}, {@link
28 * org.mal_lang.langspec.Asset}, {@link org.mal_lang.langspec.AttackStep}, and {@link
29 * org.mal_lang.langspec.Association} objects.
30 *
31 * @since 1.0.0
32 */
33 public final class Meta {
34 private final Map<String, String> entries;
35
36 private Meta(Map<String, String> entries) {
37 this.entries = Map.copyOf(requireNonNull(entries));
38 }
39
40 /**
41 * Returns whether {@code key} is the key of an entry in this {@code Meta} object.
42 *
43 * @param key the key of the entry
44 * @return whether {@code key} is the key of an entry in this {@code Meta} object
45 * @throws java.lang.NullPointerException if {@code key} is {@code null}
46 * @since 1.0.0
47 */
48 public boolean hasEntry(String key) {
49 return this.entries.containsKey(requireNonNull(key));
50 }
51
52 /**
53 * Returns the value of the entry with the key {@code key} in this {@code Meta} object.
54 *
55 * @param key the key of the entry
56 * @return the value of the entry with the key {@code key} in this {@code Meta} object
57 * @throws java.lang.NullPointerException if {@code key} is {@code null}
58 * @throws java.lang.IllegalArgumentException if {@code key} is not the key of an entry in this
59 * {@code Meta} object
60 * @since 1.0.0
61 */
62 public String getEntry(String key) {
63 if (!this.hasEntry(key)) {
64 throw new IllegalArgumentException(String.format("Entry \"%s\" not found", key));
65 }
66 return this.entries.get(key);
67 }
68
69 /**
70 * Returns all entries in this {@code Meta} object.
71 *
72 * @return all entries in this {@code Meta} object
73 * @since 1.0.0
74 */
75 public Map<String, String> getEntries() {
76 return this.entries;
77 }
78
79 JsonObject toJson() {
80 var jsonMeta = Json.createObjectBuilder();
81 for (var entry : this.entries.entrySet()) {
82 jsonMeta.add(entry.getKey(), entry.getValue());
83 }
84 return jsonMeta.build();
85 }
86
87 static Meta fromBuilder(MetaBuilder builder) {
88 return new Meta(requireNonNull(builder).getEntries());
89 }
90 }