/*
 * ====================================================================
 * 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.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 *
 */

package org.apache.http.nio.util;

import java.io.IOException;

import org.apache.http.nio.ContentEncoder;

Generic content output buffer.
Since:
4.0/**
 * Generic content output buffer.
 *
 * @since 4.0
 */
public interface ContentOutputBuffer {

    
Writes content from this buffer to the given ContentEncoder. 
Params:
encoder – content encoder.
Throws:
IOException – in case of an I/O error.
Returns:
number of bytes written.
Deprecated:
(4.3) use implementation specific methods./**
     * Writes content from this buffer to the given {@link ContentEncoder}.
     *
     * @param encoder content encoder.
     * @return number of bytes written.
     * @throws IOException in case of an I/O error.
     *
     * @deprecated (4.3) use implementation specific methods.
     */
    @Deprecated
    int produceContent(ContentEncoder encoder) throws IOException;

    
Resets the buffer by clearing its state and stored content.
/**
     * Resets the buffer by clearing its state and stored content.
     */
    void reset();

    
Deprecated:
(4.2) No longer used./**
     * @deprecated (4.2) No longer used.
     */
    @Deprecated
    void flush() throws IOException;

    
Writes len bytes from the specified byte array starting at offset off to this buffer. 
 If off is negative, or len is negative, or off+len is greater than the length of the array b, this method can throw a runtime exception. The exact type of runtime exception thrown by this method depends on implementation. 
Params:
b –     the data.
off –   the start offset in the data.
len –   the number of bytes to write.
Throws:
IOException –  if an I/O error occurs./**
     * Writes {@code len} bytes from the specified byte array
     * starting at offset {@code off} to this buffer.
     * <p>
     * If {@code off} is negative, or {@code len} is negative, or
     * {@code off+len} is greater than the length of the array
     * {@code b}, this method can throw a runtime exception. The exact type
     * of runtime exception thrown by this method depends on implementation.
     *
     * @param      b     the data.
     * @param      off   the start offset in the data.
     * @param      len   the number of bytes to write.
     * @throws  IOException  if an I/O error occurs.
     */
    void write(byte[] b, int off, int len) throws IOException;

    
Writes the specified byte to this buffer.
Params:
b –  the byte.
Throws:
IOException –  if an I/O error occurs./**
     * Writes the specified byte to this buffer.
     *
     * @param      b   the {@code byte}.
     * @throws  IOException  if an I/O error occurs.
     */
    void write(int b) throws IOException;

    
Indicates the content has been fully written.
Throws:
IOException –  if an I/O error occurs./**
     * Indicates the content has been fully written.
     * @throws  IOException  if an I/O error occurs.
     */
    void writeCompleted() throws IOException;

}