org.apache.sling.feature.Application 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;

import java.util.ArrayList;
import java.util.List;

/**
 * An application consists of
 * 
 *   Framework
 *   
Bundles
 *   
Configurations
 *   
Framework properties
 *   
Extensions
 *   
Feature ids (of the features making up this application)
 * 
 */
public class Application {
    /** The variables of this application. */
    private final KeyValueMap variables = new KeyValueMap();

    /** Container for bundles. */
    private final Bundles bundles = new Bundles();

    /** List of configurations. */
    private final Configurations configurations = new Configurations();

    /** Map of framework properties. */
    private final KeyValueMap frameworkProperties = new KeyValueMap();

    /** List of extensions. */
    private final Extensions extensions = new Extensions();

    /** List of features. */
    private final List features = new ArrayList<>();

    /** The framework id. */
    private ArtifactId framework;

    /**
     * Get the bundles
     * @return The bundles object.
     */
    public Bundles getBundles() {
        return this.bundles;
    }

    /**
     * Get the configurations
     * The list is modifiable.
     * @return The list of configurations
     */
    public Configurations getConfigurations() {
        return this.configurations;
    }

    /**
     * Get the framework properties
     * The map is modifiable
     * @return The map of properties
     */
    public KeyValueMap getFrameworkProperties() {
        return this.frameworkProperties;
    }

    /**
     * Get the list of extensions
     * The list is modifiable
     * @return The list of extension
     */
    public Extensions getExtensions() {
        return this.extensions;
    }

    /**
     * Get the list of used features to build this application
     * @return The list of features
     */
    public List getFeatureIds() {
        return this.features;
    }

    /**
     * Get the framework id
     * @return The framework id or {@code null}
     */
    public ArtifactId getFramework() {
        return framework;
    }

    /**
     * Set the framework id
     * @param framework The framework id
     */
    public void setFramework(final ArtifactId framework) {
        this.framework = framework;
    }

    /**
     * Get the variables
     * The map is modifiable
     * @return The map of variables
     */
    public KeyValueMap getVariables() {
        return this.variables;
    }

    @Override
    public String toString() {
        return "Application [features=" + this.features
                + "]";
    }
}