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 absolute 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 IoAbsoluteReader 35 { 36 37 /** 38 * Get the index of the first byte that can be accessed. 39 */ 40 int first(); 41 42 43 /** 44 * Gets the index after the last byte that can be accessed. 45 */ 46 int last(); 47 48 49 /** 50 * Gets the total number of bytes that can be accessed. 51 */ 52 int length(); 53 54 55 /** 56 * Creates an array with a view of part of this array. 57 */ 58 ByteArray slice( int index, int length ); 59 60 61 /** 62 * Gets the order of the bytes. 63 */ 64 ByteOrder order(); 65 66 67 /** 68 * Gets a <code>byte</code> from the given index. 69 */ 70 byte get( int index ); 71 72 73 /** 74 * Gets enough bytes to fill the <code>IoBuffer</code> from the given index. 75 */ 76 public void get( int index, IoBuffer bb ); 77 78 79 /** 80 * Gets a <code>short</code> from the given index. 81 */ 82 short getShort( int index ); 83 84 85 /** 86 * Gets an <code>int</code> from the given index. 87 */ 88 int getInt( int index ); 89 90 91 /** 92 * Gets a <code>long</code> from the given index. 93 */ 94 long getLong( int index ); 95 96 97 /** 98 * Gets a <code>float</code> from the given index. 99 */ 100 float getFloat( int index ); 101 102 103 /** 104 * Gets a <code>double</code> from the given index. 105 */ 106 double getDouble( int index ); 107 108 109 /** 110 * Gets a <code>char</code> from the given index. 111 */ 112 char getChar( int index ); 113 }