BufferQueueController.java revision de15a5ad14da2e9069642e6f616b66b4ae660e01 
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
19/**
20 * An output stream of objects which can be closed from either the producer or
21 * the consumer.
22 */
23public interface BufferQueueController<T> extends SafeCloseable {
24    /**
25     * Adds the given element to the stream. Streams must support calling this
26     * even after closed.
27     *
28     * @param element The element to add.
29     */
30    public void append(T element);
31
32    /**
33     * Closes the stream. Implementations must tolerate multiple calls to close.
34     */
35    public void close();
36
37    /**
38     * @return Whether the stream is closed.
39     */
40    public boolean isClosed();
41}
42