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.hc.core5.http.nio.entity;
29  
30  import java.io.IOException;
31  
32  /**
33   * Generic content output buffer.
34   *
35   * @since 4.0
36   */
37  public interface ContentOutputBuffer {
38  
39      /**
40       * Return length data stored in the buffer
41       *
42       * @return data length
43       */
44      int length();
45  
46      /**
47       * Resets the buffer by clearing its state and stored content.
48       */
49      void reset();
50  
51      /**
52       * Writes {@code len} bytes from the specified byte array
53       * starting at offset {@code off} to this buffer.
54       * <p>
55       * If {@code off} is negative, or {@code len} is negative, or
56       * {@code off+len} is greater than the length of the array
57       * {@code b}, this method can throw a runtime exception. The exact type
58       * of runtime exception thrown by this method depends on implementation.
59       *
60       * @param      b     the data.
61       * @param      off   the start offset in the data.
62       * @param      len   the number of bytes to write.
63       * @throws  IOException  if an I/O error occurs.
64       */
65      void write(byte[] b, int off, int len) throws IOException;
66  
67      /**
68       * Writes the specified byte to this buffer.
69       *
70       * @param      b   the {@code byte}.
71       * @throws  IOException  if an I/O error occurs.
72       */
73      void write(int b) throws IOException;
74  
75      /**
76       * Indicates the content has been fully written.
77       * @throws  IOException  if an I/O error occurs.
78       */
79      void writeCompleted() throws IOException;
80  
81  }