Class FileProtocolHandler

java.lang.Object

com.thecsdev.common.resource.protocol.FileProtocolHandler

All Implemented Interfaces:

ProtocolHandler

public final class FileProtocolHandler
extends Object
implements ProtocolHandler

A ProtocolHandler implementation for handling "file" protocol URIs. This handler reads files from the local filesystem and returns their contents as ResourceResponse objects.

See Also:

• URI.getScheme()

Field Summary

Fields

Modifier and Type	Field	Description
static final FileProtocolHandler	INSTANCE	The main singleton instance of FileProtocolHandler.

Method Summary

Modifier and Type	Method	Description
final @NotNull CompletableFuture<ResourceResponse>	handle(@NotNull ResourceRequest request)	Handles the given ResourceRequest and returns a CompletableFuture that will complete with a ResourceResponse.
final boolean	matches(@NotNull URI uri)	Determines if this ProtocolHandler can handle the given URI.

Methods inherited from class Object

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

Field Details

INSTANCE

public static final FileProtocolHandler INSTANCE

The main singleton instance of FileProtocolHandler.

Method Details

matches

public final boolean matches(@NotNull
 @NotNull URI uri)

Description copied from interface: ProtocolHandler

Determines if this ProtocolHandler can handle the given URI.

Specified by:

matches in interface ProtocolHandler

Parameters:

uri - The URI to check.

Returns:

true if this handler can process the URI; false otherwise.

handle

@NotNull
public final @NotNull CompletableFuture<ResourceResponse> handle(@NotNull
 @NotNull ResourceRequest request)

Description copied from interface: ProtocolHandler

Handles the given ResourceRequest and returns a CompletableFuture that will complete with a ResourceResponse.

Specified by:

handle in interface ProtocolHandler

Parameters:

request - The ResourceRequest to handle.