media/java/android/media/tv/tuner/filter/FilterConfiguration.java

/*
 * Copyright 2019 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 android.media.tv.tuner.filter;

import android.annotation.NonNull;
import android.annotation.Nullable;
import android.annotation.SystemApi;

/**
 * Filter configuration used to configure filters.
 *
 * @hide
 */
@SystemApi
public abstract class FilterConfiguration {

    @Nullable
    /* package */ final Settings mSettings;

    /* package */ FilterConfiguration(Settings settings) {
        mSettings = settings;
    }

    /**
     * Gets filter configuration type.
     */
    @Filter.Type
    public abstract int getType();

    /**
     * Gets filter Settings.
     */
    @Nullable
    public Settings getSettings() {
        return mSettings;
    }

    /**
     * Builder for {@link FilterConfiguration}.
     *
     * @param <T> The subclass to be built.
     */
    public abstract static class Builder<T extends Builder<T>> {
        /* package */ Settings mSettings;

        /* package */ Builder() {
        }

        /**
         * Sets filter settings.
         */
        @NonNull
        public T setSettings(@Nullable Settings settings) {
            mSettings = settings;
            return self();
        }
        /* package */ abstract T self();
    }
}