Mercurial Hosting > luan
annotate src/org/eclipse/jetty/io/Buffer.java @ 1038:b71ad168fe34
rename Buffer.length() to remaining()
| author | Franklin Schmidt <fschmidt@gmail.com> |
|---|---|
| date | Thu, 03 Nov 2016 22:16:11 -0600 |
| parents | 3c4c7cc7904f |
| children | a7319f14ba1e |
| rev | line source |
|---|---|
|
802
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
1 // |
|
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
2 // ======================================================================== |
|
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
3 // Copyright (c) 1995-2014 Mort Bay Consulting Pty. Ltd. |
|
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
4 // ------------------------------------------------------------------------ |
|
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
5 // All rights reserved. This program and the accompanying materials |
|
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
6 // are made available under the terms of the Eclipse Public License v1.0 |
|
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
7 // and Apache License v2.0 which accompanies this distribution. |
|
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
8 // |
|
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
9 // The Eclipse Public License is available at |
|
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
10 // http://www.eclipse.org/legal/epl-v10.html |
|
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
11 // |
|
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
12 // The Apache License v2.0 is available at |
|
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
13 // http://www.opensource.org/licenses/apache2.0.php |
|
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
14 // |
|
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
15 // You may elect to redistribute this code under either of these licenses. |
|
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
16 // ======================================================================== |
|
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
17 // |
|
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
18 |
|
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
19 package org.eclipse.jetty.io; |
|
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
20 |
|
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
21 import java.io.IOException; |
|
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
22 import java.io.InputStream; |
|
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
23 import java.io.OutputStream; |
|
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
24 import java.nio.charset.Charset; |
|
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
25 |
|
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
26 |
|
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
27 /** |
|
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
28 * Byte Buffer interface. |
|
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
29 * |
|
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
30 * This is a byte buffer that is designed to work like a FIFO for bytes. Puts and Gets operate on different |
|
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
31 * pointers into the buffer and the valid _content of the buffer is always between the getIndex and the putIndex. |
|
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
32 * |
|
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
33 * This buffer interface is designed to be similar, but not dependent on the java.nio buffers, which may |
|
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
34 * be used to back an implementation of this Buffer. The main difference is that NIO buffer after a put have |
|
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
35 * their valid _content before the position and a flip is required to access that data. |
|
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
36 * |
|
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
37 * For this buffer it is always true that: |
|
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
38 * markValue <= getIndex <= putIndex <= capacity |
|
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
39 * |
|
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
40 * |
|
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
41 * @version 1.0 |
|
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
42 */ |
|
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
43 public interface Buffer extends Cloneable |
|
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
44 { |
| 1010 | 45 public final static int |
| 46 IMMUTABLE=0, // neither indexes or contexts can be changed | |
| 47 READONLY=1, // indexes may be changed, but not content | |
| 48 READWRITE=2; // anything can be changed | |
|
802
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
49 |
| 1010 | 50 /** |
| 51 * Get the underlying array, if one exists. | |
| 52 * @return a <code>byte[]</code> backing this buffer or null if none exists. | |
| 53 */ | |
| 54 byte[] array(); | |
| 55 | |
| 56 /** | |
| 57 * | |
| 58 * @return a <code>byte[]</code> value of the bytes from the getIndex to the putIndex. | |
| 59 */ | |
| 60 byte[] asArray(); | |
| 61 | |
| 62 /** | |
| 63 * Get the underlying buffer. If this buffer wraps a backing buffer. | |
| 64 * @return The root backing buffer or this if there is no backing buffer; | |
| 65 */ | |
| 66 Buffer buffer(); | |
| 67 | |
| 68 /** | |
| 69 * | |
| 70 * The capacity of the buffer. This is the maximum putIndex that may be set. | |
| 71 * @return an <code>int</code> value | |
| 72 */ | |
| 73 int capacity(); | |
| 74 | |
| 75 /** | |
| 76 * the space remaining in the buffer. | |
| 77 * @return capacity - putIndex | |
| 78 */ | |
| 79 int space(); | |
| 80 | |
| 81 /** | |
| 82 * Clear the buffer. getIndex=0, putIndex=0. | |
| 83 */ | |
| 84 void clear(); | |
|
802
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
85 |
| 1010 | 86 /** |
| 87 * Compact the buffer by discarding bytes before the postion (or mark if set). | |
| 88 * Bytes from the getIndex (or mark) to the putIndex are moved to the beginning of | |
| 89 * the buffer and the values adjusted accordingly. | |
| 90 */ | |
| 91 void compact(); | |
| 92 | |
| 93 /** | |
| 94 * Get the byte at the current getIndex and increment it. | |
| 95 * @return The <code>byte</code> value from the current getIndex. | |
| 96 */ | |
| 97 byte get(); | |
| 98 | |
| 99 /** | |
| 100 * Get bytes from the current postion and put them into the passed byte array. | |
| 101 * The getIndex is incremented by the number of bytes copied into the array. | |
| 102 * @param b The byte array to fill. | |
| 103 * @param offset Offset in the array. | |
| 104 * @param length The max number of bytes to read. | |
| 105 * @return The number of bytes actually read. | |
| 106 */ | |
| 107 int get(byte[] b, int offset, int length); | |
|
802
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
108 |
| 1010 | 109 /** |
| 110 * | |
| 111 * @param length an <code>int</code> value | |
| 112 * @return a <code>Buffer</code> value | |
| 113 */ | |
| 114 Buffer get(int length); | |
|
802
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
115 |
| 1010 | 116 /** |
| 117 * The index within the buffer that will next be read or written. | |
| 118 * @return an <code>int</code> value >=0 <= putIndex() | |
| 119 */ | |
| 120 int getIndex(); | |
| 121 | |
| 122 /** | |
| 123 * @return true of putIndex > getIndex | |
| 124 */ | |
|
1037
3c4c7cc7904f
rename Buffer.hasContent() to hasRemaining()
Franklin Schmidt <fschmidt@gmail.com>
parents:
1032
diff
changeset
|
125 boolean hasRemaining(); |
| 1010 | 126 |
| 127 /** | |
| 128 * | |
| 129 * @return a <code>boolean</code> value true if the buffer is immutable and that neither | |
| 130 * the buffer contents nor the indexes may be changed. | |
| 131 */ | |
| 132 boolean isImmutable(); | |
| 133 | |
| 134 /** | |
| 135 * | |
| 136 * @return a <code>boolean</code> value true if the buffer is readonly. The buffer indexes may | |
| 137 * be modified, but the buffer contents may not. For example a View onto an immutable Buffer will be | |
| 138 * read only. | |
| 139 */ | |
| 140 boolean isReadOnly(); | |
| 141 | |
| 142 /** | |
| 143 * The number of bytes from the getIndex to the putIndex | |
| 144 * @return an <code>int</code> == putIndex()-getIndex() | |
| 145 */ | |
|
1038
b71ad168fe34
rename Buffer.length() to remaining()
Franklin Schmidt <fschmidt@gmail.com>
parents:
1037
diff
changeset
|
146 int remaining(); |
| 1010 | 147 |
| 148 /** | |
| 149 * Set the mark to the current getIndex. | |
| 150 */ | |
| 151 void mark(); | |
| 152 | |
| 153 /** | |
| 154 * Set the mark relative to the current getIndex | |
| 155 * @param offset an <code>int</code> value to add to the current getIndex to obtain the mark value. | |
| 156 */ | |
| 157 void mark(int offset); | |
|
802
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
158 |
| 1010 | 159 /** |
| 160 * The current index of the mark. | |
| 161 * @return an <code>int</code> index in the buffer or -1 if the mark is not set. | |
| 162 */ | |
| 163 int markIndex(); | |
|
802
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
164 |
| 1010 | 165 /** |
| 166 * Get the byte at the current getIndex without incrementing the getIndex. | |
| 167 * @return The <code>byte</code> value from the current getIndex. | |
| 168 */ | |
| 169 byte peek(); | |
|
802
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
170 |
| 1010 | 171 /** |
| 172 * Get the byte at a specific index in the buffer. | |
| 173 * @param index an <code>int</code> value | |
| 174 * @return a <code>byte</code> value | |
| 175 */ | |
| 176 byte peek(int index); | |
|
802
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
177 |
| 1032 | 178 String toString(int index, int length); |
|
802
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
179 |
| 1010 | 180 /** |
| 181 * | |
| 182 * @param index an <code>int</code> value | |
| 183 * @param b The byte array to peek into | |
| 184 * @param offset The offset into the array to start peeking | |
| 185 * @param length an <code>int</code> value | |
| 186 * @return The number of bytes actually peeked | |
| 187 */ | |
| 188 int peek(int index, byte[] b, int offset, int length); | |
| 189 | |
| 190 /** | |
| 191 * Put the contents of the buffer at the specific index. | |
| 192 * @param index an <code>int</code> value | |
| 193 * @param src a <code>Buffer</code>. If the source buffer is not modified | |
| 194 | |
| 195 * @return The number of bytes actually poked | |
| 196 */ | |
| 197 int poke(int index, Buffer src); | |
| 198 | |
| 199 /** | |
| 200 * Put a specific byte to a specific getIndex. | |
| 201 * @param index an <code>int</code> value | |
| 202 * @param b a <code>byte</code> value | |
| 203 */ | |
| 204 void poke(int index, byte b); | |
| 205 | |
| 206 /** | |
| 207 * Put a specific byte to a specific getIndex. | |
| 208 * @param index an <code>int</code> value | |
| 209 * @param b a <code>byte array</code> value | |
| 210 * @return The number of bytes actually poked | |
| 211 */ | |
| 212 int poke(int index, byte b[], int offset, int length); | |
| 213 | |
| 214 /** | |
| 215 * Write the bytes from the source buffer to the current getIndex. | |
| 216 * @param src The source <code>Buffer</code> it is not modified. | |
| 217 * @return The number of bytes actually poked | |
| 218 */ | |
| 219 int put(Buffer src); | |
|
802
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
220 |
| 1010 | 221 /** |
| 222 * Put a byte to the current getIndex and increment the getIndex. | |
| 223 * @param b a <code>byte</code> value | |
| 224 */ | |
| 225 void put(byte b); | |
| 226 | |
| 227 /** | |
| 228 * Put a byte to the current getIndex and increment the getIndex. | |
| 229 * @param b a <code>byte</code> value | |
| 230 * @return The number of bytes actually poked | |
| 231 */ | |
| 232 int put(byte[] b,int offset, int length); | |
|
802
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
233 |
| 1010 | 234 /** |
| 235 * Put a byte to the current getIndex and increment the getIndex. | |
| 236 * @param b a <code>byte</code> value | |
| 237 * @return The number of bytes actually poked | |
| 238 */ | |
| 239 int put(byte[] b); | |
|
802
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
240 |
| 1010 | 241 /** |
| 242 * The index of the first element that should not be read. | |
| 243 * @return an <code>int</code> value >= getIndex() | |
| 244 */ | |
| 245 int putIndex(); | |
| 246 | |
| 247 /** | |
| 248 * Reset the current getIndex to the mark | |
| 249 */ | |
| 250 void reset(); | |
| 251 | |
| 252 /** | |
| 253 * Set the buffers start getIndex. | |
| 254 * @param newStart an <code>int</code> value | |
| 255 */ | |
| 256 void setGetIndex(int newStart); | |
| 257 | |
| 258 /** | |
| 259 * Set a specific value for the mark. | |
| 260 * @param newMark an <code>int</code> value | |
| 261 */ | |
| 262 void setMarkIndex(int newMark); | |
| 263 | |
| 264 /** | |
| 265 * | |
| 266 * @param newLimit an <code>int</code> value | |
| 267 */ | |
| 268 void setPutIndex(int newLimit); | |
| 269 | |
| 270 /** | |
| 271 * Skip _content. The getIndex is updated by min(remaining(), n) | |
| 272 * @param n The number of bytes to skip | |
| 273 * @return the number of bytes skipped. | |
| 274 */ | |
| 275 int skip(int n); | |
|
802
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
276 |
| 1010 | 277 /** |
| 278 * | |
| 279 * @return a volitile <code>Buffer</code> from the postion to the putIndex. | |
| 280 */ | |
| 281 Buffer slice(); | |
| 282 | |
| 283 /** | |
| 284 * | |
| 285 * | |
| 286 * @return a volitile <code>Buffer</code> value from the mark to the putIndex | |
| 287 */ | |
| 288 Buffer sliceFromMark(); | |
| 289 | |
| 290 /** | |
| 291 * | |
| 292 * | |
| 293 * @param length an <code>int</code> value | |
| 294 * @return a valitile <code>Buffer</code> value from the mark of the length requested. | |
| 295 */ | |
| 296 Buffer sliceFromMark(int length); | |
| 297 | |
| 298 /** | |
| 299 * | |
| 300 * @return a <code>String</code> value describing the state and contents of the buffer. | |
| 301 */ | |
| 302 String toDetailString(); | |
|
802
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
303 |
| 1010 | 304 /* ------------------------------------------------------------ */ |
| 305 /** Read the buffer's contents from the input stream | |
| 306 * @param in input stream | |
| 307 * @param max maximum number of bytes that may be read | |
| 308 * @return actual number of bytes read or -1 for EOF | |
| 309 */ | |
| 310 int readFrom(InputStream in, int max) throws IOException; | |
| 311 | |
|
802
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
312 |
| 1010 | 313 String toString(String charset); |
| 314 | |
| 315 String toString(Charset charset); | |
|
802
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
316 |
|
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
317 } |