-
Notifications
You must be signed in to change notification settings - Fork 215
/
Placeholder.java
49 lines (44 loc) · 1.82 KB
/
Placeholder.java
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
/*
* Copyright (c) 2021 Contributors to the Eclipse Foundation
*
* See the NOTICE file(s) distributed with this work for additional
* information regarding copyright ownership.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0
*
* SPDX-License-Identifier: EPL-2.0
*/
package org.eclipse.ditto.placeholders;
import java.util.List;
import java.util.Optional;
/**
* Definition of a placeholder expression in the format {@code prefix:name}.
*
* @param <T> the type which is required to resolve a placeholder
*/
public interface Placeholder<T> extends Expression {
/**
* Resolves the placeholder variable by name.
*
* @param placeholderSource the source from which to the placeholder is resolved, e.g. a Thing id.
* @param name the placeholder variable name (i. e., the part after ':').
* @return The first value this placeholder resolved for the given placeholder source and the given variable nam,
* or an empty optional if no value could be resolved.
* @deprecated Use {@link #resolveValues(Object, String)} instead to get all resolved values.
*/
@Deprecated
default Optional<String> resolve(T placeholderSource, String name) {
return resolveValues(placeholderSource, name).stream().findFirst();
}
/**
* Resolves the placeholder variable by name.
*
* @param placeholderSource the source from which to the placeholder is resolved, e.g. a Thing id.
* @param name the placeholder variable name (i. e., the part after ':').
* @return All values this placeholder resolved for the given placeholder source and the given variable name.
* @since 2.4.0
*/
List<String> resolveValues(T placeholderSource, String name);
}