001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.juneau.encoders;
018
019import java.io.*;
020
021/**
022 * Interface that identifies an output stream has having a <c>finish()</c> method.
023 *
024 * <h5 class='section'>See Also:</h5><ul>
025 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/RestServerEncoders">Encoders</a>
026 * </ul>
027 */
028public interface Finishable {
029
030   /**
031    * Finishes writing compressed data to the output stream without closing the underlying stream.
032    *
033    * <p>
034    * Use this method when applying multiple filters in succession to the same output stream.
035    *
036    * @throws IOException Thrown by underlying stream.
037    */
038   void finish() throws IOException;
039}