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 <a href="http://mina.apache.org">Apache MINA Project</a>
32   */
33  public interface IoRelativeReader
34  {
35  
36      /**
37       * Gets the number of remaining bytes that can be read.
38       */
39      int getRemaining();
40  
41  
42      /**
43       * Checks if there are any remaining bytes that can be read.
44       */
45      boolean hasRemaining();
46  
47  
48      /**
49       * Advances the reader by the given number of bytes.
50       */
51      void skip( int length );
52  
53  
54      /**
55       * Creates an array with a view of part of this array.
56       */
57      ByteArray slice( int length );
58  
59  
60      /**
61       * Gets the order of the bytes.
62       */
63      ByteOrder order();
64  
65  
66      /**
67       * Gets a <code>byte</code> and advances the reader.
68       */
69      byte get();
70  
71  
72      /**
73       * Gets enough bytes to fill the <code>IoBuffer</code> and advances the reader.
74       */
75      void get( IoBuffer bb );
76  
77  
78      /**
79       * Gets a <code>short</code> and advances the reader.
80       */
81      short getShort();
82  
83  
84      /**
85       * Gets an <code>int</code> and advances the reader.
86       */
87      int getInt();
88  
89  
90      /**
91       * Gets a <code>long</code> and advances the reader.
92       */
93      long getLong();
94  
95  
96      /**
97       * Gets a <code>float</code> and advances the reader.
98       */
99      float getFloat();
100 
101 
102     /**
103      * Gets a <code>double</code> and advances the reader.
104      */
105     double getDouble();
106 
107 
108     /**
109      * Gets a <code>char</code> and advances the reader.
110      */
111     char getChar();
112 }