Package org.apache.maven.index.reader.resource

Class PathWritableResource

java.lang.Object

org.apache.maven.index.reader.resource.PathWritableResource

All Implemented Interfaces:

Closeable, AutoCloseable, ResourceHandler.Resource, WritableResourceHandler.WritableResource

public class PathWritableResource
extends Object
implements WritableResourceHandler.WritableResource

A WritableResourceHandler.WritableResource that represents a Path.

Constructor Summary

Constructors

Constructor	Description
PathWritableResource(Path path)

Method Summary

Modifier and Type	Method	Description
void	close()	Default close method is no-op, override if implementation requires.
InputStream	read()	Returns the InputStream stream of the resource, if exists, null otherwise.
OutputStream	write()	Returns the OutputStream stream of the resource, if exists, it will replace the existing content, or if not exists, the resource will be created.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PathWritableResource

public PathWritableResource(Path path)

Method Details

write

public OutputStream write()
                   throws IOException

Description copied from interface: WritableResourceHandler.WritableResource

Returns the OutputStream stream of the resource, if exists, it will replace the existing content, or if not exists, the resource will be created. The stream should be closed by caller, otherwise resource leaks might be introduced. How and when content is written is left to implementation, but it is guaranteed that this method is called only once, and will be followed by ResourceHandler.Resource.close() on the resource itself. Implementation does not have to be "read consistent", in a way to worry what subsequent ResourceHandler.Resource.read() method will return, as mixed calls will not happen on same instance of resource.

Specified by:

write in interface WritableResourceHandler.WritableResource

Throws:

IOException

read

public InputStream read()
                 throws IOException

Description copied from interface: ResourceHandler.Resource

Returns the InputStream stream of the resource, if exists, null otherwise. The stream should be closed by caller, otherwise resource leaks might be introduced.

Specified by:

read in interface ResourceHandler.Resource

Throws:

IOException

close

public void close()
           throws IOException

Description copied from interface: ResourceHandler.Resource

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

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface ResourceHandler.Resource

Throws:

IOException