Package com.djrapitops.plan.delivery.web.resource

Interface WebResource

All Known Implementing Classes:

WebResource.ByteResource, WebResource.LazyWebResource

public interface WebResource

Represents a customizable resource.

You can use the create methods for simple resources when using ResourceService.

It is assumed that any text based files are encoded in UTF-8.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	WebResource.ByteResource
static final class	WebResource.LazyWebResource

Method Summary

Modifier and Type	Method	Description
byte[]	asBytes()
InputStream	asStream()
String	asString()	Return the resource as a UTF-8 String.
static WebResource	create(byte[] content)	Create a new WebResource from byte array.
static WebResource	create(InputStream in)	Creates a new WebResource from an InputStream.
static WebResource	create(InputStream in, Long lastModified)	Creates a new WebResource from an InputStream.
static WebResource	create(String utf8String)	Create a new WebResource from an UTF-8 String.
static WebResource	create(Supplier<InputStream> in, Long lastModified)	Create a lazy WebResource that only reads contents if necessary.
default Optional<Long>	getLastModified()

Method Details

create

static WebResource create(byte[] content)

Create a new WebResource from byte array.

Parameters:

content - Bytes of the resource.

Returns:

WebResource.

create

static WebResource create(String utf8String)

Create a new WebResource from an UTF-8 String.

Parameters:

utf8String - String in UTF-8 encoding.

Returns:

WebResource.

create

static WebResource create(InputStream in)
                   throws IOException

Creates a new WebResource from an InputStream.

Parameters:

in - InputStream for the resource, closed after inside the method.

Returns:

WebResource.

Throws:

IOException - If the stream can not be read.

create

static WebResource create(InputStream in,
 Long lastModified)
                   throws IOException

Creates a new WebResource from an InputStream.

Parameters:

in - InputStream for the resource, closed after inside the method.

lastModified - Epoch millisecond the resource was last modified

Returns:

WebResource.

Throws:

IOException - If the stream can not be read.

create

static WebResource create(Supplier<InputStream> in,
 Long lastModified)

Create a lazy WebResource that only reads contents if necessary.

Parameters:

in - Supplier for InputStream, a lazy method that reads input when necessary.

lastModified - Last modified date for the resource.

Returns:

WebResource.

asBytes

byte[] asBytes()

asString

String asString()

Return the resource as a UTF-8 String.

Returns:

The resource in UTF-8.

asStream

InputStream asStream()

getLastModified

default Optional<Long> getLastModified()