Package org.apache.maven.index.reader

Interface ResourceHandler

All Superinterfaces:

AutoCloseable, Closeable

All Known Subinterfaces:

WritableResourceHandler

All Known Implementing Classes:

BufferedResourceHandler, BufferedWritableResourceHandler, PathWritableResourceHandler, UriResourceHandler

public interface ResourceHandler
extends Closeable

Maven Index resource abstraction, that should be handled as a resource (is Closeable. That means, that implementations could perform any extra activity as FS locking or so (if uses FS as backing store). Is used by single thread only.

Since:

5.1.2

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ResourceHandler.Resource	Handle of content.

Method Summary

Modifier and Type	Method	Description
default void	close()	Default close method is no-op, override if implementation requires.
ResourceHandler.Resource	locate(String name)	Returns the ResourceHandler.Resource with name, non null.

Method Details

locate

ResourceHandler.Resource locate(String name)
                         throws IOException

Returns the ResourceHandler.Resource with name, non null.

Parameters:

name - Resource name, guaranteed to be non-null and is FS and URL safe string.

Throws:

IOException

close

default void close()
            throws IOException

Default close method is no-op, override if implementation requires.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException