53 lines
1.2 KiB
Java
53 lines
1.2 KiB
Java
/*
|
|
* Copyright 2015-2016 Hippo Seven
|
|
*
|
|
* 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.hippo.streampipe;
|
|
|
|
import androidx.annotation.NonNull;
|
|
|
|
import java.io.IOException;
|
|
import java.io.InputStream;
|
|
|
|
/**
|
|
* A pipe to open {@code InputStream}
|
|
*/
|
|
public interface InputStreamPipe {
|
|
|
|
/**
|
|
* Obtain the {@code InputStreamPipe}.
|
|
* Call it before opening {@code InputStream}.
|
|
*/
|
|
void obtain();
|
|
|
|
/**
|
|
* Release the {@code InputStreamPipe}.
|
|
*/
|
|
void release();
|
|
|
|
/**
|
|
* Open {@code InputStream}
|
|
*
|
|
* @return the {@code InputStream}
|
|
*/
|
|
@NonNull
|
|
InputStream open() throws IOException;
|
|
|
|
/**
|
|
* Close the {@code InputStream} opened before.
|
|
*/
|
|
void close();
|
|
}
|