org.apache.sling.feature.builder.BuilderContext Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.apache.sling.feature Show documentation

A feature describes an OSGi system

There is a newer version: 2.0.0

Show newest version

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.sling.feature.builder;

import java.util.List;
import java.util.concurrent.CopyOnWriteArrayList;

/**
 * Builder context holds services used by {@link ApplicationBuilder}
 * and {@link FeatureBuilder}.
 */
public class BuilderContext {

    private final FeatureProvider provider;

    private final List featureExtensionHandlers = new CopyOnWriteArrayList<>();

    /**
     * Create a new context
     *
     * @param provider A provider providing the included features
     * @throws IllegalArgumentException If feature provider is {@code null}
     */
    public BuilderContext(final FeatureProvider provider) {
        if ( provider == null ) {
            throw new IllegalArgumentException("Provider must not be null");
        }
        this.provider = provider;
    }

    /**
     * Add a feature extension handler
     * @param handler A handler
     * @return This instance
     */
    public BuilderContext add(final FeatureExtensionHandler handler) {
        featureExtensionHandlers.add(handler);
        return this;
    }

    /**
     * Get the feature provider.
     * @return The feature provider
     */
    FeatureProvider getFeatureProvider() {
        return this.provider;
    }

    /**
     * Get the list of extension handlers
     * @return The list of handlers
     */
    List getFeatureExtensionHandlers() {
        return this.featureExtensionHandlers;
    }

    /**
     * Clone the context and replace the feature provider
     * @param featureProvider The new feature provider
     * @return Cloned context
     */
    BuilderContext clone(final FeatureProvider featureProvider) {
        final BuilderContext ctx = new BuilderContext(featureProvider);
        ctx.featureExtensionHandlers.addAll(featureExtensionHandlers);
        return ctx;
    }
}