ProductFlavorContainer.java

/*
 * Copyright (C) 2013 The Android Open Source Project
 *
 * Licensed 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 com.android.builder.model;

import com.android.annotations.NonNull;

import java.util.Collection;

/**
 * A Container of all the data related to {@link ProductFlavor}.
 */
public interface ProductFlavorContainer {

    /**
     * The Product Flavor itself.
     *
     * @return the product flavor
     */
    @NonNull
    ProductFlavor getProductFlavor();

    /**
     * The associated main sources of the product flavor
     *
     * @return the main source provider.
     */
    @NonNull
    SourceProvider getSourceProvider();

    /**
     * Returns a list of ArtifactMetaData/SourceProvider association.
     *
     * @return a list of ArtifactMetaData/SourceProvider association.
     */
    @NonNull
    Collection<SourceProviderContainer> getExtraSourceProviders();
}