View Javadoc

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  
23  import java.nio.ByteOrder;
24  
25  import org.apache.mina.core.buffer.IoBuffer;
26  
27  
28  /**
29   * Provides relative read access to a sequence of bytes.
30   * 
31   * @author The Apache MINA Project (dev@mina.apache.org)
32   * @version $Rev$, $Date$
33   */
34  public interface IoRelativeWriter
35  {
36  
37      /**
38       * Gets the number of remaining bytes that can be read.
39       */
40      int getRemaining();
41  
42  
43      /**
44       * Checks if there are any remaining bytes that can be read.
45       */
46      boolean hasRemaining();
47  
48  
49      /**
50       * Advances the writer by the given number of bytes.
51       */
52      void skip( int length );
53  
54  
55      /**
56       * Gets the order of the bytes.
57       */
58      ByteOrder order();
59  
60  
61      /**
62       * Puts a <code>byte</code> and advances the reader.
63       */
64      void put( byte b );
65  
66  
67      /**
68       * Puts enough bytes to fill the <code>IoBuffer</code> and advances the reader.
69       */
70      void put( IoBuffer bb );
71  
72  
73      /**
74       * Puts a <code>short</code> and advances the reader.
75       */
76      void putShort( short s );
77  
78  
79      /**
80       * Puts an <code>int</code> and advances the reader.
81       */
82      void putInt( int i );
83  
84  
85      /**
86       * Puts a <code>long</code> and advances the reader.
87       */
88      void putLong( long l );
89  
90  
91      /**
92       * Puts a <code>float</code> and advances the reader.
93       */
94      void putFloat( float f );
95  
96  
97      /**
98       * Puts a <code>double</code> and advances the reader.
99       */
100     void putDouble( double d );
101 
102 
103     /**
104      * Puts a <code>char</code> and advances the reader.
105      */
106     void putChar( char c );
107 }