|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.simpleframework.util.buffer.FilterAllocator
public class FilterAllocator
The FilterAllocator
object is used to provide a means
to provide a general set of constraints around buffer allocation.
It can ensure that a minimum capacity is used for default allocation
and that an upper limit is used for allocation. In general this can
be used in conjunction with another Allocator
which may
not have such constraints. It ensures that a set of requirements can
be observed when allocating buffers.
Field Summary | |
---|---|
protected int |
capacity
This is the default initial minimum capacity of the buffer. |
protected int |
limit
This is the maximum number of bytes that can be allocated. |
protected Allocator |
source
This is the allocator the underlying buffer is allocated with. |
Constructor Summary | |
---|---|
FilterAllocator(Allocator source)
Constructor for the FilterAllocator object. |
|
FilterAllocator(Allocator source,
int capacity)
Constructor for the FilterAllocator object. |
|
FilterAllocator(Allocator source,
int capacity,
int limit)
Constructor for the FilterAllocator object. |
Method Summary | |
---|---|
Buffer |
allocate()
This method is used to allocate a default buffer. |
Buffer |
allocate(int size)
This method is used to allocate a default buffer. |
void |
close()
This method is used to close the allocator so that resources that are occupied by the allocator can be freed. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected Allocator source
protected int capacity
protected int limit
Constructor Detail |
---|
public FilterAllocator(Allocator source)
FilterAllocator
object. This is
used to instantiate the allocator with a default buffer size of
half a kilobyte. This ensures that it can be used for general
purpose byte storage and for minor I/O tasks.
source
- this is where the underlying buffer is allocatedpublic FilterAllocator(Allocator source, int capacity)
FilterAllocator
object. This is
used to instantiate the allocator with a specified buffer size.
This is typically used when a very specific buffer capacity is
required, for example a request body with a known length.
source
- this is where the underlying buffer is allocatedcapacity
- the initial capacity of the allocated bufferspublic FilterAllocator(Allocator source, int capacity, int limit)
FilterAllocator
object. This is
used to instantiate the allocator with a specified buffer size.
This is typically used when a very specific buffer capacity is
required, for example a request body with a known length.
source
- this is where the underlying buffer is allocatedcapacity
- the initial capacity of the allocated bufferslimit
- this is the maximum buffer size created by thisMethod Detail |
---|
public Buffer allocate() throws java.io.IOException
allocate
in interface Allocator
java.io.IOException
public Buffer allocate(int size) throws java.io.IOException
allocate
in interface Allocator
size
- the initial capacity of the allocated buffer
java.io.IOException
public void close() throws java.io.IOException
close
in interface java.io.Closeable
close
in interface Allocator
java.io.IOException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |