summaryrefslogtreecommitdiff
path: root/src/main/java/DNPM/analyzer/AnalyzerUtils.java
blob: 4a7e5a97e6a544fa1da0bd82284acd24ba33bcf4 (plain)
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
package DNPM.analyzer;

import java.util.Map;
import java.util.Optional;

/**
 * Klasse mit Hilfsfunktionen für Analyzer
 *
 * @since 0.1.0
 */
public class AnalyzerUtils {

    /**
     * Prüft, ob in InputMap einen Eintrag mit key <code>key</code> und Typ <code>type</code>
     * gefunden wurde.
     *
     * @param input InputMap
     * @param key Key des Werts
     * @param type Typ des Werts
     * @return <code>true</code>>, wenn ein Wert von dem Typ gefunden wurde
     */
    public static boolean requiredValuePresent(final Map<String, Object> input, final String key, final Class<?> type) {
        var value = input.get(key);

        if (null == value) {
            return false;
        }

        return type.isInstance(value);
    }

    /**
     * Übergibt ein Optional mit Wert, wenn in InputMap ein Eintrag mit key <code>key</code> und Typ <code>type</code>
     * gefunden wurde. Anderenfalls ein leeres Optional
     *
     * <p><b>Beispiel</b>
     * <pre>
     *     var id = AnalyzerUtils.getRequiredValue(input, "id", Integer.class);
     *     if (id.isEmpty()) {
     *         logger.error("Keine ID angegeben!");
     *         return false;
     *     }
     *
     *     var idNummer = id.get();
     *     ...
     * </pre>
     *
     * @param input InputMap
     * @param key Key des Werts
     * @param type Typ des Werts
     * @return Optional mit entsprechendem Wert oder leeres Optional
     */
    public static <T> Optional<T> getRequiredValue(final Map<String, Object> input, final String key, final Class<T> type) {
        if (! requiredValuePresent(input, key, type)) {
            return Optional.empty();
        }

        @SuppressWarnings("unchecked")
        var result = Optional.of((T)input.get(key));

        return result;
    }

    /**
     * Prüft, ob ein Wert in der InputMap als Zeichenkette dem angegebenen RegExp entspricht
     *
     * @param input InputMap
     * @param key Key des Werts
     * @param regexp Der zu prüfende reguläre Ausdruck
     * @return <code>true</code>>, wenn ein Wert gefunden wurde, der dem RegExp entspricht
     */
    public static boolean requiredValueMatches(final Map<String, Object> input, final String key, final String regexp) {
        var value = input.get(key);

        if (null == value) {
            return false;
        }

        return value.toString().matches(regexp);
    }

    /**
     * Übergibt ein Optional mit dem Wert als Zeichenkette, wenn er dem angegebenen RegExp entspricht.
     * Hierzu wird die Methode <code>toString()</code> auf den Wert angewendet.
     *
     * @param input InputMap
     * @param key Key des Werts
     * @param regexp Der zu prüfende reguläre Ausdruck
     * @return Optional mit entsprechendem Wert als Zeichenkette oder leeres Optional
     */
    public static Optional<String> getRequiredValueMatching(final Map<String, Object> input, final String key, final String regexp) {
        if (! requiredValueMatches(input, key, regexp)) {
            return Optional.empty();
        }

        return Optional.of(input.get(key).toString());
    }

    /**
     * Prüft, ob ein Wert in der InputMap eine ID ist und damit eine Zahl größer Null ist.
     *
     * @param input InputMap
     * @param key Key des Werts
     * @return <code>true</code>>, wenn ein Wert gefunden wurde, der dem RegExp entspricht
     */
    public static boolean requiredValueIsId(final Map<String, Object> input, final String key) {
        return requiredValuePresent(input, key, Integer.class) && Integer.valueOf(input.get(key).toString()) > 0;
    }

    /**
     * Übergibt ein Optional, wenn der Wert eine ID ist und damit eine Zahl größer Null ist.
     * <p><b>Beispiel</b>
     * <pre>
     *     var id = AnalyzerUtils.getRequiredId(input, "id");
     *     if (id.isEmpty()) {
     *         logger.error("Keine gültige ID angegeben!");
     *         return false;
     *     }
     *
     *     // Ist hier immer größer als Null
     *     var idNummer = id.get();
     *     ...
     * </pre>
     *
     * @param input InputMap
     * @param key Key des Werts
     * @return Optional mit entsprechendem Wert oder leeres Optional
     */
    public static Optional<Integer> getRequiredId(final Map<String, Object> input, final String key) {
        if (! requiredValuePresent(input, key, Integer.class)) {
            return Optional.empty();
        }

        var id = (int)input.get(key);

        if (id > 0) {
            return Optional.of(id);
        }

        return Optional.empty();
    }

}