View Javadoc

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   * Buffer for storing content to be streamed out to a {@link ContentEncoder}.
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      int produceContent(ContentEncoder encoder) throws IOException;
49  
50      /**
51       * Resets the buffer by clearing its state and stored content.
52       */
53      void reset();
54  
55      /**
56       * @deprecated (4.2) No longer used.
57       */
58      @Deprecated
59      void flush() throws IOException;
60  
61      /**
62       * Writes <code>len</code> bytes from the specified byte array
63       * starting at offset <code>off</code> to this buffer.
64       * <p>
65       * If <code>off</code> is negative, or <code>len</code> is negative, or
66       * <code>off+len</code> is greater than the length of the array
67       * <code>b</code>, this method can throw a runtime exception. The exact type
68       * of runtime exception thrown by this method depends on implementation.
69       *
70       * @param      b     the data.
71       * @param      off   the start offset in the data.
72       * @param      len   the number of bytes to write.
73       * @exception  IOException  if an I/O error occurs.
74       */
75      void write(byte[] b, int off, int len) throws IOException;
76  
77      /**
78       * Writes the specified byte to this buffer.
79       *
80       * @param      b   the <code>byte</code>.
81       * @exception  IOException  if an I/O error occurs.
82       */
83      void write(int b) throws IOException;
84  
85      /**
86       * Indicates the content has been fully written.
87       * @exception  IOException  if an I/O error occurs.
88       */
89      void writeCompleted() throws IOException;
90  
91  }