1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 *
19 */
20 package org.apache.mina.util.byteaccess;
21
22 import java.nio.ByteOrder;
23
24 import org.apache.mina.core.buffer.IoBuffer;
25
26 /**
27 * Provides relative read access to a sequence of bytes.
28 *
29 * @author <a href="http://mina.apache.org">Apache MINA Project</a>
30 */
31 public interface IoRelativeWriter {
32
33 /**
34 * @return the number of remaining bytes that can be read.
35 */
36 int getRemaining();
37
38 /**
39 * @return if there are any remaining bytes that can be read.
40 */
41 boolean hasRemaining();
42
43 /**
44 * Advances the writer by the given number of bytes.
45 *
46 * @param length The number of bytes to skip
47 */
48 void skip(int length);
49
50 /**
51 * @return the bytes' order
52 */
53 ByteOrder order();
54
55 /**
56 * Puts a <code>byte</code> and advances the reader.
57 *
58 * @param b The byte to put
59 */
60 void put(byte b);
61
62 /**
63 * Puts enough bytes to fill the <code>IoBuffer</code> and advances the reader.
64 *
65 * @param bb The bytes to put
66 */
67 void put(IoBuffer bb);
68
69 /**
70 * Puts a <code>short</code> and advances the reader.
71 *
72 * @param s The short to put
73 */
74 void putShort(short s);
75
76 /**
77 * Puts an <code>int</code> and advances the reader.
78 *
79 * @param i The int to put
80 */
81 void putInt(int i);
82
83 /**
84 * Puts a <code>long</code> and advances the reader.
85 *
86 * @param l The long to put
87 */
88 void putLong(long l);
89
90 /**
91 * Puts a <code>float</code> and advances the reader.
92 *
93 * @param f The float to put
94 */
95 void putFloat(float f);
96
97 /**
98 * Puts a <code>double</code> and advances the reader.
99 *
100 * @param d The double to put
101 */
102 void putDouble(double d);
103
104 /**
105 * Puts a <code>char</code> and advances the reader.
106 *
107 * @param c The char to put
108 */
109 void putChar(char c);
110 }