blob: 5f61ad2c6d5546691e060399d06c87cfc7cc339d [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 Rop57ffa3f2016-02-19 12:54:30 +000021import java.util.Dictionary;
Pierre De Rop11527502016-02-18 21:07:16 +000022import java.util.Objects;
23
24import org.apache.felix.dm.Component;
Pierre De Rop57ffa3f2016-02-19 12:54:30 +000025import org.apache.felix.dm.lambda.ConfigurationDependencyBuilder;
Pierre De Rop11527502016-02-18 21:07:16 +000026
27/**
28 * Represents a callback(Configuration, Component) which accepts a configuration type for wrapping properties
Pierre De Rop57ffa3f2016-02-19 12:54:30 +000029 * behind a dynamic proxy interface.
Pierre De Rop11527502016-02-18 21:07:16 +000030 *
31 * <p> The T generic parameter represents the type of the class on which the callback is invoked on.
32 * <p> The U generic parameter represents the type of the configuration class passed to the callback argument.
33 *
Pierre De Rop57ffa3f2016-02-19 12:54:30 +000034 * <p> Using such callback provides a way for creating type-safe configurations from the actual {@link Dictionary} that is
35 * normally injected by Dependency Manager.
36 * For more information about configuration types, please refer to {@link ConfigurationDependencyBuilder}.
37 *
Pierre De Rop11527502016-02-18 21:07:16 +000038 * @author <a href="mailto:dev@felix.apache.org">Felix Project Team</a>
39 */
40@FunctionalInterface
41public interface CbConfigurationComponent<T, U> extends SerializableLambda {
42 /**
43 * Handles the given arguments
44 * @param instance the Component implementation instance on which the callback is invoked on.
45 * @param configuration the configuration proxy
46 * @param component the callback Component
47 */
48 void accept(T instance, U configuration, Component component);
49
50 default CbConfigurationComponent<T, U> andThen(CbConfigurationComponent<T, U> after) {
51 Objects.requireNonNull(after);
52 return (T instance, U configuration, Component component) -> {
53 accept(instance, configuration, component);
54 after.accept(instance, configuration, component);
55 };
56 }
57}