-
Notifications
You must be signed in to change notification settings - Fork 215
/
SubstitutionStrategy.java
42 lines (38 loc) · 1.88 KB
/
SubstitutionStrategy.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
/*
* Copyright (c) 2022 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.policies.enforcement.placeholders.strategies;
import org.eclipse.ditto.base.model.headers.DittoHeadersSettable;
import org.eclipse.ditto.policies.enforcement.placeholders.HeaderBasedPlaceholderSubstitutionAlgorithm;
/**
* Defines the (placeholder) substitution strategy for a certain command (which is of type {@link DittoHeadersSettable}.
*
* @param <T> the subtype of {@link DittoHeadersSettable} handled by this strategy.
*/
public interface SubstitutionStrategy<T extends DittoHeadersSettable<?>> {
/**
* Checks whether this strategy is applicable for the given {@code dittoHeadersSettable}.
*
* @param dittoHeadersSettable the command which may have content to be substituted.
* @return {@code true}, if this strategy is applicable; {@code false}, otherwise.
*/
boolean matches(final DittoHeadersSettable<?> dittoHeadersSettable);
/**
* Apply (placeholder) substitution on the given {@code withDittoHeaders} using the {@code substitutionAlgorithm}.
*
* @param withDittoHeaders the command which may have content to be substituted.
* @param substitutionAlgorithm the algorithm to be used for placeholder substitution.
* @return a copy of {@code withDittoHeaders} with substitutions applied, if substitutions were necessary; the
* same {@code withDittoHeaders}, if no substitutions were necessary.
*/
T apply(T withDittoHeaders, HeaderBasedPlaceholderSubstitutionAlgorithm substitutionAlgorithm);
}