DataBufferFactory.java

/*
 * Copyright 2002-2016 the original author or authors.
 *
 * 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.springframework.core.io.buffer;

import java.nio.ByteBuffer;

/**
 * A factory for {@link DataBuffer}s, allowing for allocation and wrapping of data
 * buffers.
 *
 * @author Arjen Poutsma
 * @see DataBuffer
 */
public interface DataBufferFactory {

	/**
	 * Allocates a data buffer of a default initial capacity. Depending on the underlying
	 * implementation and its configuration, this will be heap-based or direct buffer.
	 * @return the allocated buffer
	 */
	DataBuffer allocateBuffer();

	/**
	 * Allocates a data buffer of the given initial capacity. Depending on the underlying
	 * implementation and its configuration, this will be heap-based or direct buffer.
	 * @param initialCapacity the initial capacity of the buffer to allocateBuffer
	 * @return the allocated buffer
	 */
	DataBuffer allocateBuffer(int initialCapacity);

	/**
	 * Wraps the given {@link ByteBuffer} in a {@code DataBuffer}.
	 * @param byteBuffer the NIO byte buffer to wrap
	 * @return the wrapped buffer
	 */
	DataBuffer wrap(ByteBuffer byteBuffer);

}