/*
* Copyright 2015 Terracotta, Inc., a Software AG company.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.terracotta.offheapstore.buffersource;
import java.nio.ByteBuffer;
A source of NIO buffers of some type.
Author: Chris Dennis
/**
* A source of NIO buffers of some type.
*
* @author Chris Dennis
*/
public interface BufferSource {
Allocates a buffer of the given size.
If a suitable buffer cannot be allocated then null
should be returned. Implementations may place restrictions on the valid size value they will accept.
Params: - size – required buffer size
Returns: a buffer of the required size
/**
* Allocates a buffer of the given size.
* <p>
* If a suitable buffer cannot be allocated then {@code null} should be
* returned. Implementations may place restrictions on the valid size value
* they will accept.
*
* @param size required buffer size
* @return a buffer of the required size
*/
ByteBuffer allocateBuffer(int size);
}