BufferQueueController.java revision 4961ad31d9a877e3a68566fb5d4b33b7f79ce44e 
1/*
2 * Copyright (C) 2014 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package com.android.camera.async;
18
19import javax.annotation.Nonnull;
20
21/**
22 * An output stream of objects which can be closed from either the producer or
23 * the consumer.
24 */
25public interface BufferQueueController<T> extends Updatable<T>, SafeCloseable {
26    /**
27     * Adds the given element to the stream. Streams must support calling this
28     * even after closed.
29     *
30     * @param element The element to add.
31     */
32    @Override
33    public void update(@Nonnull T element);
34
35    /**
36     * Closes the stream. Implementations must tolerate multiple calls to close.
37     */
38    @Override
39    public void close();
40
41    /**
42     * @return Whether the stream is closed.
43     */
44    public boolean isClosed();
45}
46