Mercurial Hosting > luan
annotate src/org/eclipse/jetty/io/Buffer.java @ 1027:6d17a257b03f
remove Buffer.asImmutableBuffer()
| author | Franklin Schmidt <fschmidt@gmail.com> |
|---|---|
| date | Wed, 02 Nov 2016 23:58:37 -0600 |
| parents | 6647dbc8be71 |
| children | 4e5e9e3c25b3 |
| 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 | |
| 49 public final boolean VOLATILE=true; // The buffer may change outside of current scope. | |
| 50 public final boolean NON_VOLATILE=false; | |
|
802
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
51 |
| 1010 | 52 /** |
| 53 * Get the underlying array, if one exists. | |
| 54 * @return a <code>byte[]</code> backing this buffer or null if none exists. | |
| 55 */ | |
| 56 byte[] array(); | |
| 57 | |
| 58 /** | |
| 59 * | |
| 60 * @return a <code>byte[]</code> value of the bytes from the getIndex to the putIndex. | |
| 61 */ | |
| 62 byte[] asArray(); | |
| 63 | |
| 64 /** | |
| 65 * Get the underlying buffer. If this buffer wraps a backing buffer. | |
| 66 * @return The root backing buffer or this if there is no backing buffer; | |
| 67 */ | |
| 68 Buffer buffer(); | |
| 69 | |
| 70 /** | |
| 71 * | |
| 72 * @return a readonly version of this <code>Buffer</code>. | |
| 73 */ | |
| 74 Buffer asReadOnlyBuffer(); | |
|
802
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
75 |
| 1010 | 76 /** |
| 77 * | |
| 78 * The capacity of the buffer. This is the maximum putIndex that may be set. | |
| 79 * @return an <code>int</code> value | |
| 80 */ | |
| 81 int capacity(); | |
| 82 | |
| 83 /** | |
| 84 * the space remaining in the buffer. | |
| 85 * @return capacity - putIndex | |
| 86 */ | |
| 87 int space(); | |
| 88 | |
| 89 /** | |
| 90 * Clear the buffer. getIndex=0, putIndex=0. | |
| 91 */ | |
| 92 void clear(); | |
|
802
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
93 |
| 1010 | 94 /** |
| 95 * Compact the buffer by discarding bytes before the postion (or mark if set). | |
| 96 * Bytes from the getIndex (or mark) to the putIndex are moved to the beginning of | |
| 97 * the buffer and the values adjusted accordingly. | |
| 98 */ | |
| 99 void compact(); | |
| 100 | |
| 101 /** | |
| 102 * Get the byte at the current getIndex and increment it. | |
| 103 * @return The <code>byte</code> value from the current getIndex. | |
| 104 */ | |
| 105 byte get(); | |
| 106 | |
| 107 /** | |
| 108 * Get bytes from the current postion and put them into the passed byte array. | |
| 109 * The getIndex is incremented by the number of bytes copied into the array. | |
| 110 * @param b The byte array to fill. | |
| 111 * @param offset Offset in the array. | |
| 112 * @param length The max number of bytes to read. | |
| 113 * @return The number of bytes actually read. | |
| 114 */ | |
| 115 int get(byte[] b, int offset, int length); | |
|
802
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
116 |
| 1010 | 117 /** |
| 118 * | |
| 119 * @param length an <code>int</code> value | |
| 120 * @return a <code>Buffer</code> value | |
| 121 */ | |
| 122 Buffer get(int length); | |
|
802
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
123 |
| 1010 | 124 /** |
| 125 * The index within the buffer that will next be read or written. | |
| 126 * @return an <code>int</code> value >=0 <= putIndex() | |
| 127 */ | |
| 128 int getIndex(); | |
| 129 | |
| 130 /** | |
| 131 * @return true of putIndex > getIndex | |
| 132 */ | |
| 133 boolean hasContent(); | |
| 134 | |
| 135 /** | |
| 136 * | |
| 137 * @return a <code>boolean</code> value true if case sensitive comparison on this buffer | |
| 138 */ | |
| 139 boolean equalsIgnoreCase(Buffer buffer); | |
|
802
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
140 |
|
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
141 |
| 1010 | 142 /** |
| 143 * | |
| 144 * @return a <code>boolean</code> value true if the buffer is immutable and that neither | |
| 145 * the buffer contents nor the indexes may be changed. | |
| 146 */ | |
| 147 boolean isImmutable(); | |
| 148 | |
| 149 /** | |
| 150 * | |
| 151 * @return a <code>boolean</code> value true if the buffer is readonly. The buffer indexes may | |
| 152 * be modified, but the buffer contents may not. For example a View onto an immutable Buffer will be | |
| 153 * read only. | |
| 154 */ | |
| 155 boolean isReadOnly(); | |
| 156 | |
| 157 /** | |
| 158 * | |
| 159 * @return a <code>boolean</code> value true if the buffer contents may change | |
| 160 * via alternate paths than this buffer. If the contents of this buffer are to be used outside of the | |
| 161 * current context, then a copy must be made. | |
| 162 */ | |
| 163 boolean isVolatile(); | |
|
802
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
164 |
| 1010 | 165 /** |
| 166 * The number of bytes from the getIndex to the putIndex | |
| 167 * @return an <code>int</code> == putIndex()-getIndex() | |
| 168 */ | |
| 169 int length(); | |
| 170 | |
| 171 /** | |
| 172 * Set the mark to the current getIndex. | |
| 173 */ | |
| 174 void mark(); | |
| 175 | |
| 176 /** | |
| 177 * Set the mark relative to the current getIndex | |
| 178 * @param offset an <code>int</code> value to add to the current getIndex to obtain the mark value. | |
| 179 */ | |
| 180 void mark(int offset); | |
|
802
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
181 |
| 1010 | 182 /** |
| 183 * The current index of the mark. | |
| 184 * @return an <code>int</code> index in the buffer or -1 if the mark is not set. | |
| 185 */ | |
| 186 int markIndex(); | |
|
802
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
187 |
| 1010 | 188 /** |
| 189 * Get the byte at the current getIndex without incrementing the getIndex. | |
| 190 * @return The <code>byte</code> value from the current getIndex. | |
| 191 */ | |
| 192 byte peek(); | |
|
802
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
193 |
| 1010 | 194 /** |
| 195 * Get the byte at a specific index in the buffer. | |
| 196 * @param index an <code>int</code> value | |
| 197 * @return a <code>byte</code> value | |
| 198 */ | |
| 199 byte peek(int index); | |
|
802
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
200 |
| 1010 | 201 /** |
| 202 * | |
| 203 * @param index an <code>int</code> value | |
| 204 * @param length an <code>int</code> value | |
| 205 * @return The <code>Buffer</code> value from the requested getIndex. | |
| 206 */ | |
| 207 Buffer peek(int index, int length); | |
|
802
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
208 |
| 1010 | 209 /** |
| 210 * | |
| 211 * @param index an <code>int</code> value | |
| 212 * @param b The byte array to peek into | |
| 213 * @param offset The offset into the array to start peeking | |
| 214 * @param length an <code>int</code> value | |
| 215 * @return The number of bytes actually peeked | |
| 216 */ | |
| 217 int peek(int index, byte[] b, int offset, int length); | |
| 218 | |
| 219 /** | |
| 220 * Put the contents of the buffer at the specific index. | |
| 221 * @param index an <code>int</code> value | |
| 222 * @param src a <code>Buffer</code>. If the source buffer is not modified | |
| 223 | |
| 224 * @return The number of bytes actually poked | |
| 225 */ | |
| 226 int poke(int index, Buffer src); | |
| 227 | |
| 228 /** | |
| 229 * Put a specific byte to a specific getIndex. | |
| 230 * @param index an <code>int</code> value | |
| 231 * @param b a <code>byte</code> value | |
| 232 */ | |
| 233 void poke(int index, byte b); | |
| 234 | |
| 235 /** | |
| 236 * Put a specific byte to a specific getIndex. | |
| 237 * @param index an <code>int</code> value | |
| 238 * @param b a <code>byte array</code> value | |
| 239 * @return The number of bytes actually poked | |
| 240 */ | |
| 241 int poke(int index, byte b[], int offset, int length); | |
| 242 | |
| 243 /** | |
| 244 * Write the bytes from the source buffer to the current getIndex. | |
| 245 * @param src The source <code>Buffer</code> it is not modified. | |
| 246 * @return The number of bytes actually poked | |
| 247 */ | |
| 248 int put(Buffer src); | |
|
802
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
249 |
| 1010 | 250 /** |
| 251 * Put a byte to the current getIndex and increment the getIndex. | |
| 252 * @param b a <code>byte</code> value | |
| 253 */ | |
| 254 void put(byte b); | |
| 255 | |
| 256 /** | |
| 257 * Put a byte to the current getIndex and increment the getIndex. | |
| 258 * @param b a <code>byte</code> value | |
| 259 * @return The number of bytes actually poked | |
| 260 */ | |
| 261 int put(byte[] b,int offset, int length); | |
|
802
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
262 |
| 1010 | 263 /** |
| 264 * Put a byte to the current getIndex and increment the getIndex. | |
| 265 * @param b a <code>byte</code> value | |
| 266 * @return The number of bytes actually poked | |
| 267 */ | |
| 268 int put(byte[] b); | |
|
802
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
269 |
| 1010 | 270 /** |
| 271 * The index of the first element that should not be read. | |
| 272 * @return an <code>int</code> value >= getIndex() | |
| 273 */ | |
| 274 int putIndex(); | |
| 275 | |
| 276 /** | |
| 277 * Reset the current getIndex to the mark | |
| 278 */ | |
| 279 void reset(); | |
| 280 | |
| 281 /** | |
| 282 * Set the buffers start getIndex. | |
| 283 * @param newStart an <code>int</code> value | |
| 284 */ | |
| 285 void setGetIndex(int newStart); | |
| 286 | |
| 287 /** | |
| 288 * Set a specific value for the mark. | |
| 289 * @param newMark an <code>int</code> value | |
| 290 */ | |
| 291 void setMarkIndex(int newMark); | |
| 292 | |
| 293 /** | |
| 294 * | |
| 295 * @param newLimit an <code>int</code> value | |
| 296 */ | |
| 297 void setPutIndex(int newLimit); | |
| 298 | |
| 299 /** | |
| 300 * Skip _content. The getIndex is updated by min(remaining(), n) | |
| 301 * @param n The number of bytes to skip | |
| 302 * @return the number of bytes skipped. | |
| 303 */ | |
| 304 int skip(int n); | |
|
802
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
305 |
| 1010 | 306 /** |
| 307 * | |
| 308 * @return a volitile <code>Buffer</code> from the postion to the putIndex. | |
| 309 */ | |
| 310 Buffer slice(); | |
| 311 | |
| 312 /** | |
| 313 * | |
| 314 * | |
| 315 * @return a volitile <code>Buffer</code> value from the mark to the putIndex | |
| 316 */ | |
| 317 Buffer sliceFromMark(); | |
| 318 | |
| 319 /** | |
| 320 * | |
| 321 * | |
| 322 * @param length an <code>int</code> value | |
| 323 * @return a valitile <code>Buffer</code> value from the mark of the length requested. | |
| 324 */ | |
| 325 Buffer sliceFromMark(int length); | |
| 326 | |
| 327 /** | |
| 328 * | |
| 329 * @return a <code>String</code> value describing the state and contents of the buffer. | |
| 330 */ | |
| 331 String toDetailString(); | |
|
802
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
332 |
| 1010 | 333 /* ------------------------------------------------------------ */ |
| 334 /** Read the buffer's contents from the input stream | |
| 335 * @param in input stream | |
| 336 * @param max maximum number of bytes that may be read | |
| 337 * @return actual number of bytes read or -1 for EOF | |
| 338 */ | |
| 339 int readFrom(InputStream in, int max) throws IOException; | |
| 340 | |
|
802
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
341 |
| 1010 | 342 String toString(String charset); |
| 343 | |
| 344 String toString(Charset charset); | |
|
802
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
345 |
|
3428c60d7cfc
replace jetty jars with source
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff
changeset
|
346 } |