MappedBufferCleaner (Apache Tika 1.23 API)

java.lang.Object
- org.apache.tika.io.MappedBufferCleaner

public class MappedBufferCleaner
extends Object

Copied/pasted from the Apache Lucene/Solr project.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`UNMAP_NOT_SUPPORTED_REASON`	if `UNMAP_SUPPORTED` is `false`, this contains the reason why unmapping is not supported.
`static boolean`	`UNMAP_SUPPORTED`	`true`, if this platform supports unmapping mmapped files.

Constructor Summary

Constructors
Constructor Description

MappedBufferCleaner()

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type Method Description

static void freeBuffer(ByteBuffer b)
If a cleaner is available, this buffer will be cleaned.
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - UNMAP_SUPPORTED
```
public static final boolean UNMAP_SUPPORTED
```
    true, if this platform supports unmapping mmapped files.
  - UNMAP_NOT_SUPPORTED_REASON
```
public static final String UNMAP_NOT_SUPPORTED_REASON
```
    if UNMAP_SUPPORTED is false, this contains the reason why unmapping is not supported.
- Constructor Detail
  - MappedBufferCleaner
```
public MappedBufferCleaner()
```
- Method Detail
  - freeBuffer
```
public static void freeBuffer(ByteBuffer b)
                       throws IOException
```
    If a cleaner is available, this buffer will be cleaned. Otherwise, this is a no-op.
    
    Parameters:
    
    b - buffer to clean; no-op if buffer is null
    
    Throws:
    
    IOException