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