1 /*
2 * Licensed under the Apache License, Version 2.0 (the "License");
3 * you may not use this file except in compliance with the License.
4 * You may obtain a copy of the License at
5 *
6 * http://www.apache.org/licenses/LICENSE-2.0
7 *
8 * Unless required by applicable law or agreed to in writing, software
9 * distributed under the License is distributed on an "AS IS" BASIS,
10 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11 * See the License for the specific language governing permissions and
12 * limitations under the License.
13 */
14
15 package org.basepom.mojo.propertyhelper.macros;
16
17 import org.basepom.mojo.propertyhelper.FieldContext;
18 import org.basepom.mojo.propertyhelper.ValueProvider;
19 import org.basepom.mojo.propertyhelper.definitions.MacroDefinition;
20
21 import java.util.Optional;
22
23 /**
24 * Macro implementation. All macro classes must implement this interface.
25 */
26 public interface MacroType {
27
28 /**
29 * Returns the value for a specific macro invocation.
30 *
31 * @param macroDefinition The macro definition
32 * @param valueProvider A value provider that either provides a property backed value or the initial (default) value
33 * @param context The Field context
34 * @return An {@link Optional} wrapping a string value. If the macro returns {@link Optional#empty()}, the field value will be the empty string
35 */
36 Optional<String> getValue(MacroDefinition macroDefinition,
37 ValueProvider valueProvider,
38 FieldContext context);
39 }