build-system/gradle-core/src/main/java/com/android/build/gradle/internal/dsl/LanguageSplitOptions.java

/*
 * Copyright (C) 2014 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.build.gradle.internal.dsl;

import com.android.annotations.NonNull;
import com.google.common.collect.Sets;
import java.util.Arrays;
import java.util.HashSet;
import java.util.List;
import java.util.Set;

/**
 * Encapsulates settings for <a
 * href="https://developer.android.com/studio/build/configure-apk-splits.html#configure-abi-split">
 * building per-language (or locale) APKs</a>.
 *
 * <p><b>Note:</b> Building per-language APKs is supported only when <a
 * href="https://developer.android.com/topic/instant-apps/guides/config-splits.html">building
 * configuration APKs</a> for <a
 * href="https://developer.android.com/topic/instant-apps/index.html">Android Instant Apps</a>.
 */
public class LanguageSplitOptions {

    private boolean enable = false;
    private Set<String> include;

    /**
     * Collection of include patterns.
     */
    public Set<String> getInclude() {
        return include;
    }

    public void setInclude(@NonNull List<String> list) {
        include = Sets.newHashSet(list);
    }

    /**
     * Adds an include pattern.
     */
    public void include(@NonNull String... includes) {
        if (include == null) {
            include = Sets.newHashSet(includes);
            return;
        }

        include.addAll(Arrays.asList(includes));
    }

    @NonNull
    public Set<String> getApplicationFilters() {
        return include == null || !enable ? new HashSet<>() : include;
    }

    /**
     * enables or disables splits for language
     */
    public void setEnable(boolean enable) {
        this.enable = enable;
    }

    /**
     * Returns true if splits should be generated for languages.
     */
    public boolean isEnable() {
        return enable;
    }

    /**
     * Sets whether the build system should determine the splits based on the "language-*" folders
     * in the resources.
     *
     * <p>If the auto mode is set to true, the include list will be ignored.
     *
     * @param auto true to automatically set the splits list based on the folders presence, false
     *             to use the include list.
     *
     * @deprecated LanguageSplitOptions.auto is not supported anymore.
     */
    @Deprecated
    public void setAuto(boolean auto) {
        throw new RuntimeException("LanguageSplitOptions.auto is not supported anymore.");
    }
}