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