public interface

IoConfig

implements ReadableConfig

 androidx.camera.core.internal.IoConfig

Subclasses:

ImageCaptureConfig

Gradle dependencies

compile group: 'androidx.camera', name: 'camera-core', version: '1.2.0-alpha01'

  • groupId: androidx.camera
  • artifactId: camera-core
  • version: 1.2.0-alpha01

Artifact androidx.camera:camera-core:1.2.0-alpha01 it located at Google repository (https://maven.google.com/)

Overview

Configuration containing IO related options.

Summary

Fields
public static final Config.Option<java.util.concurrent.Executor>OPTION_IO_EXECUTOR

Option: camerax.core.io.ioExecutor

Methods
public java.util.concurrent.ExecutorgetIoExecutor()

Returns the executor that will be used for IO tasks.

public java.util.concurrent.ExecutorgetIoExecutor(java.util.concurrent.Executor valueIfMissing)

Returns the executor that will be used for IO tasks.

Fields

public static final Config.Option<java.util.concurrent.Executor> OPTION_IO_EXECUTOR

Option: camerax.core.io.ioExecutor

Methods

public java.util.concurrent.Executor getIoExecutor(java.util.concurrent.Executor valueIfMissing)

Returns the executor that will be used for IO tasks.

Parameters:

valueIfMissing: The value to return if this configuration option has not been set.

Returns:

The stored value or valueIfMissing if the value does not exist in this configuration.

public java.util.concurrent.Executor getIoExecutor()

Returns the executor that will be used for IO tasks.

Returns:

The stored value, if it exists in this configuration.

Source

/*
 * 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 androidx.camera.core.internal;

import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import androidx.annotation.RequiresApi;
import androidx.camera.core.impl.ReadableConfig;

import java.util.concurrent.Executor;

/**
 * Configuration containing IO related options.
 */
@RequiresApi(21) // TODO(b/200306659): Remove and replace with annotation on package-info.java
public interface IoConfig extends ReadableConfig {

    // Option Declarations:
    // *********************************************************************************************

    /**
     * Option: camerax.core.io.ioExecutor
     */
    Option<Executor> OPTION_IO_EXECUTOR =
            Option.create("camerax.core.io.ioExecutor", Executor.class);

    // *********************************************************************************************

    /**
     * Returns the executor that will be used for IO tasks.
     *
     * @param valueIfMissing The value to return if this configuration option has not been set.
     * @return The stored value or <code>valueIfMissing</code> if the value does not exist in this
     * configuration.
     */
    @Nullable
    default Executor getIoExecutor(@Nullable Executor valueIfMissing) {
        return retrieveOption(OPTION_IO_EXECUTOR, valueIfMissing);
    }


    /**
     * Returns the executor that will be used for IO tasks.
     *
     * @return The stored value, if it exists in this configuration.
     * @throws IllegalArgumentException if the option does not exist in this configuration.
     */
    @NonNull
    default Executor getIoExecutor() {
        return retrieveOption(OPTION_IO_EXECUTOR);
    }

    /**
     * Builder for a {@link IoConfig}.
     *
     * @param <B> The top level builder type for which this builder is composed with.
     */
    interface Builder<B> {

        /**
         * Sets the default executor that will be used for IO tasks.
         *
         * @param executor The executor which will be used for IO tasks.
         * @return the current Builder.
         */
        @NonNull
        B setIoExecutor(@NonNull Executor executor);
    }
}