org.icij.extract.report

Interface ReportMap

All Superinterfaces:

AutoCloseable, ConcurrentMap<TikaDocument,Report>, Map<TikaDocument,Report>

All Known Implementing Classes:

HashMapReportMap

public interface ReportMap
extends ConcurrentMap<TikaDocument,Report>, AutoCloseable

The interface for a report map.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
boolean	fastPut(TikaDocument key, Report value) Allow implementations to define a faster method for putting values into the map that doesn't require the previous value to be returned.
default Collection<Class<? extends Exception>>	journalableExceptions() Allow implementations to define a list of exception classes that when caught, would indicate to the caller that arguments should be journaled and flushed later.

Methods inherited from interface java.util.concurrent.ConcurrentMap

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

fastPut

boolean fastPut(TikaDocument key,
                Report value)

Allow implementations to define a faster method for putting values into the map that doesn't require the previous value to be returned. This can reduce the processing time for kinds of maps and/or reduce the RTT (round-trip time) for distributed maps.

Parameters:

key - the document to set the status of

value - the new status

Returns:

true if the field was new when the value was set; false if it was updated

journalableExceptions

default Collection<Class<? extends Exception>> journalableExceptions()

Allow implementations to define a list of exception classes that when caught, would indicate to the caller that arguments should be journaled and flushed later.

Returns:

a collection of exception classes