com.djrapitops.plan.delivery.web.resource

Interface WebResource

All Known Implementing Classes:

WebResource.ByteResource

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 and Description
static class	WebResource.ByteResource

Method Summary

Modifier and Type	Method and Description
byte[]	asBytes()
java.io.InputStream	asStream()
java.lang.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(java.io.InputStream in) Creates a new WebResource from an InputStream.
static WebResource	create(java.lang.String utf8String) Create a new WebResource from an UTF-8 String.

Method Detail

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(java.lang.String utf8String)

Create a new WebResource from an UTF-8 String.

Parameters:

utf8String - String in UTF-8 encoding.

Returns:

WebResource.

create

static WebResource create(java.io.InputStream in)
                   throws java.io.IOException

Creates a new WebResource from an InputStream.

Parameters:

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

Returns:

WebResource.

Throws:

java.io.IOException - If the stream can not be read.

asBytes

byte[] asBytes()

asString

java.lang.String asString()

Return the resource as a UTF-8 String.

Returns:

The resource in UTF-8.

asStream

java.io.InputStream asStream()