KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > mina > common > ByteBufferAllocator


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.common;
21
22 /**
23  * Allocates {@link ByteBuffer}s and manages them. Please implement this
24  * interface if you need more advanced memory management scheme.
25  *
26  * @author The Apache Directory Project (mina-dev@directory.apache.org)
27  * @version $Rev: 555855 $, $Date: 2007-07-13 12:19:00 +0900 (금, 13 7월 2007) $
28  */
29 public interface ByteBufferAllocator {
30     /**
31      * Returns the buffer which is capable of the specified size.
32      *
33      * @param capacity the capacity of the buffer
34      * @param direct <tt>true</tt> to get a direct buffer,
35      * <tt>false</tt> to get a heap buffer.
36      */
37     ByteBuffer allocate(int capacity, boolean direct);
38
39     /**
40      * Wraps the specified NIO {@link java.nio.ByteBuffer} into MINA buffer.
41      */
42     ByteBuffer wrap(java.nio.ByteBuffer JavaDoc nioBuffer);
43
44     /**
45      * Dispose of this allocator.
46      */
47     void dispose();
48 }
49
Popular Tags