xref: /libcore/luni/src/main/java/java/io/Flushable.java

/* Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 java.io;

/**
 * Defines an interface for classes that can (or need to) be flushed, typically
 * before some output processing is considered to be finished and the object
 * gets closed.
 */
public interface Flushable {
    /**
     * Flushes the object by writing out any buffered data to the underlying
     * output.
     *
     * @throws IOException
     *             if there are any issues writing the data.
     */
    void flush() throws IOException;
}