blob: 6cdc2e74bcf647b0e3cb8e3fa51f7c08b4c74a95 [file] [log] [blame]
Pierre De Rop6e8f9212016-02-20 21:44:59 +00001/*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
Pierre De Rop11527502016-02-18 21:07:16 +000019package org.apache.felix.dm.lambda.callbacks;
20
Pierre De Rop11527502016-02-18 21:07:16 +000021import java.util.Dictionary;
Pierre De Rop11527502016-02-18 21:07:16 +000022import java.util.Objects;
23
Pierre De Rop57ffa3f2016-02-19 12:54:30 +000024import org.apache.felix.dm.lambda.ConfigurationDependencyBuilder;
25
Pierre De Rop11527502016-02-18 21:07:16 +000026/**
27 * Represents a callback(Configuration) that is invoked on a Component implementation class.
Pierre De Rop57ffa3f2016-02-19 12:54:30 +000028 * The callback accepts a type-safe configuration class for wrapping properties behind a dynamic proxy interface.
Pierre De Rop11527502016-02-18 21:07:16 +000029 *
30 * <p> The T generic parameter represents the type of the class on which the callback is invoked on.
31 * <p> The U generic parameter represents the type of the configuration class passed to the callback argument.
32 *
Pierre De Rop57ffa3f2016-02-19 12:54:30 +000033 * <p> Using such callback provides a way for creating type-safe configurations from the actual {@link Dictionary} that is
Pierre De Rop11527502016-02-18 21:07:16 +000034 * normally injected by Dependency Manager.
Pierre De Rop57ffa3f2016-02-19 12:54:30 +000035 * For more information about configuration types, please refer to {@link ConfigurationDependencyBuilder}.
Pierre De Rop11527502016-02-18 21:07:16 +000036 *
37 * @author <a href="mailto:dev@felix.apache.org">Felix Project Team</a>
38 */
39@FunctionalInterface
40public interface CbConfiguration<T, U> extends SerializableLambda {
41 /**
42 * Handles the given arguments
43 * @param instance the Component implementation instance on which the callback is invoked on.
44 * @param configuration the configuration proxy
45 */
46 void accept(T instance, U configuration);
47
48 default CbConfiguration<T, U> andThen(CbConfiguration<T, U> after) {
49 Objects.requireNonNull(after);
50 return (T instance, U configuration) -> {
51 accept(instance, configuration);
52 after.accept(instance, configuration);
53 };
54 }
55}