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 absolute write access to a sequence of bytes.
28   * 
29   * @author <a href="http://mina.apache.org">Apache MINA Project</a>
30   */
31  public interface IoAbsoluteWriter {
32  
33      /**
34       * Get the index of the first byte that can be accessed.
35       */
36      int first();
37  
38      /**
39       * Gets the index after the last byte that can be accessed.
40       */
41      int last();
42  
43      /**
44       * Gets the order of the bytes.
45       */
46      ByteOrder order();
47  
48      /**
49       * Puts a <code>byte</code> at the given index.
50       */
51      void put(int index, byte b);
52  
53      /**
54       * Puts bytes from the <code>IoBuffer</code> at the given index.
55       */
56      public void put(int index, IoBuffer bb);
57  
58      /**
59       * Puts a <code>short</code> at the given index.
60       */
61      void putShort(int index, short s);
62  
63      /**
64       * Puts an <code>int</code> at the given index.
65       */
66      void putInt(int index, int i);
67  
68      /**
69       * Puts a <code>long</code> at the given index.
70       */
71      void putLong(int index, long l);
72  
73      /**
74       * Puts a <code>float</code> at the given index.
75       */
76      void putFloat(int index, float f);
77  
78      /**
79       * Puts a <code>double</code> at the given index.
80       */
81      void putDouble(int index, double d);
82  
83      /**
84       * Puts a <code>char</code> at the given index.
85       */
86      void putChar(int index, char c);
87  }