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.impl.nio;
29  
30  import java.io.IOException;
31  import java.nio.ByteBuffer;
32  import java.nio.channels.ReadableByteChannel;
33  import java.nio.channels.WritableByteChannel;
34  
35  import org.apache.hc.core5.util.Args;
36  
37  /**
38   * A buffer that expand its capacity on demand. Internally, this class is backed
39   * by an instance of {@link ByteBuffer}.
40   * <p>
41   * This class is not thread safe.
42   * </p>
43   * @since 5.0
44   */
45  public class BufferedData extends ExpandableBuffer {
46  
47      public static BufferedData allocate(final int bufferSize) {
48          return new BufferedData(bufferSize);
49      }
50  
51      protected BufferedData(final int bufferSize) {
52          super(bufferSize);
53      }
54  
55      @Override
56      public final boolean hasData() {
57          return super.hasData();
58      }
59  
60      @Override
61      public final int length() {
62          return super.length();
63      }
64  
65      @Override
66      public final int capacity() {
67          return super.capacity();
68      }
69  
70      @Override
71      public final void clear() {
72          super.clear();
73      }
74  
75      public final void put(final ByteBuffer src) {
76          Args.notNull(src, "Data source");
77          setInputMode();
78          final int requiredCapacity = buffer().position() + src.remaining();
79          ensureAdjustedCapacity(requiredCapacity);
80          buffer().put(src);
81      }
82  
83      public final int readFrom(final ReadableByteChannel channel) throws IOException {
84          Args.notNull(channel, "Channel");
85          setInputMode();
86          if (!buffer().hasRemaining()) {
87              expand();
88          }
89          return channel.read(buffer());
90      }
91  
92      public final int writeTo(final WritableByteChannel dst) throws IOException {
93          if (dst == null) {
94              return 0;
95          }
96          setOutputMode();
97          return dst.write(buffer());
98      }
99  
100     public final ByteBuffer data() {
101         setOutputMode();
102         return buffer();
103     }
104 
105 }