forked from oras-project/oras-java
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathAnnotations.java
More file actions
148 lines (135 loc) · 4.69 KB
/
Annotations.java
File metadata and controls
148 lines (135 loc) · 4.69 KB
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
/*-
* =LICENSE=
* ORAS Java SDK
* ===
* Copyright (C) 2024 - 2025 ORAS
* ===
* 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.
* =LICENSEEND=
*/
package land.oras;
import java.util.HashMap;
import java.util.Map;
import java.util.stream.Collectors;
import land.oras.utils.JsonUtils;
import org.jspecify.annotations.NullMarked;
import org.jspecify.annotations.Nullable;
/**
* Record for annotations
*
* @param manifestAnnotations Annotations for the manifest
* @param configAnnotations Annotations for the config
* @param filesAnnotations Annotations for the layers/files
*/
@NullMarked
public record Annotations(
Map<String, String> configAnnotations,
Map<String, String> manifestAnnotations,
Map<String, Map<String, String>> filesAnnotations) {
/**
* Create a new annotations record with only manifest annotations
* @param manifestAnnotations The manifest annotations
* @return The annotations
*/
public static Annotations ofManifest(@Nullable Map<String, String> manifestAnnotations) {
if (manifestAnnotations == null) {
return empty();
}
return new Annotations(new HashMap<>(), manifestAnnotations, new HashMap<>());
}
/**
* Create a new annotations record with only config annotations
* @param configAnnotations The config annotations
* @return The annotations
*/
public static Annotations ofConfig(Map<String, String> configAnnotations) {
return new Annotations(configAnnotations, new HashMap<>(), new HashMap<>());
}
/**
* Empty annotations
* @return The empty annotations
*/
public static Annotations empty() {
return new Annotations(new HashMap<>(), new HashMap<>(), new HashMap<>());
}
/**
* Get the manifest annotations for a file
* @param key The key
* @return The annotations
*/
public Map<String, String> getFileAnnotations(String key) {
return this.filesAnnotations().getOrDefault(key, new HashMap<>());
}
/**
* Annotations file format
*/
private static class AnnotationFile extends HashMap<String, Map<String, String>> {
/**
* Get the manifest annotations
*
* @return The manifest annotations
*/
public Map<String, String> getManifestAnnotations() {
return this.getOrDefault("$manifest", new HashMap<>());
}
/**
* Get the config annotations
*
* @return The config annotations
*/
public Map<String, String> getConfigAnnotations() {
return this.getOrDefault("$config", new HashMap<>());
}
/**
* Get the files annotations without the manifest and config annotations
*
* @return The files annotations
*/
public Map<String, Map<String, String>> getFilesAnnotations() {
return this.entrySet().stream()
.filter(entry -> !"$manifest".equals(entry.getKey())
&& !"$config".equals(entry.getKey())) // Filter out $manifest and $config
.collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue));
}
/**
* Get the annotations for a file
* @param key The key
* @return The annotations
*/
public Map<String, String> getFileAnnotations(String key) {
return this.getOrDefault(key, new HashMap<>());
}
}
/**
* Convert the annotations from a JSON string
*
* @param json The JSON string
* @return The annotations
*/
public static Annotations fromJson(String json) {
AnnotationFile file = JsonUtils.fromJson(json, AnnotationFile.class);
return new Annotations(file.getConfigAnnotations(), file.getManifestAnnotations(), file.getFilesAnnotations());
}
/**
* Convert the annotations to a JSON string
*
* @return The JSON string
*/
public String toJson() {
AnnotationFile file = new AnnotationFile();
file.put("$manifest", manifestAnnotations());
file.put("$config", configAnnotations());
file.putAll(filesAnnotations());
return JsonUtils.toJson(file);
}
}