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