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