1 /**
2 * Portions of this software was developed by employees of the National Institute
3 * of Standards and Technology (NIST), an agency of the Federal Government and is
4 * being made available as a public service. Pursuant to title 17 United States
5 * Code Section 105, works of NIST employees are not subject to copyright
6 * protection in the United States. This software may be subject to foreign
7 * copyright. Permission in the United States and in foreign countries, to the
8 * extent that NIST may hold copyright, to use, copy, modify, create derivative
9 * works, and distribute this software and its documentation without fee is hereby
10 * granted on a non-exclusive basis, provided that this notice and disclaimer
11 * of warranty appears in all copies.
12 *
13 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
14 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
15 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
17 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
18 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT
19 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
20 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
21 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
22 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
23 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
24 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
25 */
26
27 package gov.nist.secauto.swid.builder;
28
29 import java.util.HashMap;
30 import java.util.Map;
31
32 public interface VersionScheme {
33 Integer getIndex();
34
35 String getName();
36
37 static final Map<String, VersionScheme> byValueMap = new HashMap<>();
38
39 static final Map<Integer, VersionScheme> byIndexMap = new HashMap<>();
40
41 /**
42 * Initialize the mapping of version scheme index and text values.
43 *
44 * @param index
45 * the index position
46 * @param value
47 * the human-readable value
48 */
49 default void init(Integer index, String value) {
50 if (index != null) {
51 synchronized (byIndexMap) {
52 byIndexMap.put(index, this);
53 }
54 }
55 synchronized (byValueMap) {
56 byValueMap.put(value, this);
57 }
58 }
59
60 public static VersionScheme assignPrivateVersionScheme(int indexValue, String name) {
61 // force initialization of the known roles
62 KnownVersionScheme.values();
63 VersionScheme retval = null;
64 synchronized (byValueMap) {
65 @SuppressWarnings("unlikely-arg-type")
66 VersionScheme value = byValueMap.get(indexValue);
67 retval = value;
68 }
69 if (retval == null) {
70 retval = new UnknownVersionScheme(indexValue, name);
71 } else if (retval.getName().equals(name)) {
72 // return the current role
73 } else {
74 throw new IllegalStateException("the version scheme with the name '" + retval.getName()
75 + "' is already assigned to the index value '" + indexValue + "'");
76 }
77 return retval;
78 }
79
80 /**
81 * Lookup a version scheme by an index value.F
82 *
83 * @param value
84 * the index value to search for
85 * @return the matching role or {@code null} if no matching role was not found.
86 */
87 public static VersionScheme lookupByIndex(int value) {
88 // force initialization of the known roles
89 KnownVersionScheme.values();
90 VersionScheme retval = null;
91 synchronized (byIndexMap) {
92 retval = byIndexMap.get(value);
93 }
94 return retval;
95 }
96
97 /**
98 * Lookup a version scheme by a human-readable name.
99 *
100 * @param name
101 * the name to lookup
102 * @return the matching version scheme or {@code null} if no matching version scheme was not found.
103 */
104 public static VersionScheme lookupByName(String name) {
105 // force initialization of the known roles
106 KnownVersionScheme.values();
107 VersionScheme retval = null;
108 synchronized (byValueMap) {
109 retval = byValueMap.get(name);
110 }
111
112 if (retval == null) {
113 retval = new UnknownVersionScheme(name);
114 }
115 return retval;
116 }
117
118 }