1 /* 2 * ==================================================================== 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * ==================================================================== 20 * 21 * This software consists of voluntary contributions made by many 22 * individuals on behalf of the Apache Software Foundation. For more 23 * information on the Apache Software Foundation, please see 24 * <http://www.apache.org/>. 25 * 26 */ 27 28 package org.apache.http.nio.util; 29 30 import java.io.IOException; 31 32 import org.apache.http.nio.ContentEncoder; 33 34 /** 35 * Generic content output buffer. 36 * 37 * @since 4.0 38 */ 39 public interface ContentOutputBuffer { 40 41 /** 42 * Writes content from this buffer to the given {@link ContentEncoder}. 43 * 44 * @param encoder content encoder. 45 * @return number of bytes written. 46 * @throws IOException in case of an I/O error. 47 * 48 * @deprecated (4.3) use implementation specific methods. 49 */ 50 @Deprecated 51 int produceContent(ContentEncoder encoder) throws IOException; 52 53 /** 54 * Resets the buffer by clearing its state and stored content. 55 */ 56 void reset(); 57 58 /** 59 * @deprecated (4.2) No longer used. 60 */ 61 @Deprecated 62 void flush() throws IOException; 63 64 /** 65 * Writes {@code len} bytes from the specified byte array 66 * starting at offset {@code off} to this buffer. 67 * <p> 68 * If {@code off} is negative, or {@code len} is negative, or 69 * {@code off+len} is greater than the length of the array 70 * {@code b}, this method can throw a runtime exception. The exact type 71 * of runtime exception thrown by this method depends on implementation. 72 * 73 * @param b the data. 74 * @param off the start offset in the data. 75 * @param len the number of bytes to write. 76 * @throws IOException if an I/O error occurs. 77 */ 78 void write(byte[] b, int off, int len) throws IOException; 79 80 /** 81 * Writes the specified byte to this buffer. 82 * 83 * @param b the {@code byte}. 84 * @throws IOException if an I/O error occurs. 85 */ 86 void write(int b) throws IOException; 87 88 /** 89 * Indicates the content has been fully written. 90 * @throws IOException if an I/O error occurs. 91 */ 92 void writeCompleted() throws IOException; 93 94 }