net.covers1624.quack.net.httpapi

Class WebBody.PathBody

java.lang.Object

net.covers1624.quack.net.httpapi.WebBody.PathBody

All Implemented Interfaces:

WebBody

Enclosing interface:

WebBody

public static class WebBody.PathBody
extends java.lang.Object
implements WebBody

Nested Class Summary

Nested classes/interfaces inherited from interface net.covers1624.quack.net.httpapi.WebBody

WebBody.BytesBody, WebBody.PathBody

Field Summary

Fields

Modifier and Type	Field and Description
java.nio.file.Path	path

Constructor Summary

Constructors

Constructor and Description
PathBody(java.nio.file.Path path, @Nullable java.lang.String contentType)

Method Summary

Modifier and Type	Method and Description
@Nullable java.lang.String	contentType() The mime content type for this data.
long	length() The length of the data.
boolean	multiOpenAllowed() Checks if this WebBody supports WebBody.open() being called multiple times.
java.io.InputStream	open() Open a stream to read the body data.
java.nio.channels.ReadableByteChannel	openChannel() Open a byte channel into a body data.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.covers1624.quack.net.httpapi.WebBody

asBytes, asString, asString, bytes, bytes, path, path, string, string, string, string

Field Detail

path

public final java.nio.file.Path path

Constructor Detail

PathBody

public PathBody(java.nio.file.Path path,
                @Nullable
                @Nullable java.lang.String contentType)

Method Detail

open

public java.io.InputStream open()
                         throws java.io.IOException

Description copied from interface: WebBody

Open a stream to read the body data.

Specified by:

open in interface WebBody

Returns:

The stream.

Throws:

java.io.IOException - If an IO error occurs.

openChannel

public java.nio.channels.ReadableByteChannel openChannel()
                                                  throws java.io.IOException

Description copied from interface: WebBody

Open a byte channel into a body data.

If the underlying data does not support Channels, the WebBody.open() InputStream will be wrapped to a ReadableByteChannel.

Specified by:

openChannel in interface WebBody

Returns:

The channel.

Throws:

java.io.IOException - If an IO error occurs.

multiOpenAllowed

public boolean multiOpenAllowed()

Description copied from interface: WebBody

Checks if this WebBody supports WebBody.open() being called multiple times.

Specified by:

multiOpenAllowed in interface WebBody

Returns:

If the body can be opened multiple times.

length

public long length()

Description copied from interface: WebBody

The length of the data.

Specified by:

length in interface WebBody

Returns:

The length in bytes. -1 for unknown.

contentType

@Nullable
public @Nullable java.lang.String contentType()

Description copied from interface: WebBody

The mime content type for this data.

Specified by:

contentType in interface WebBody

Returns:

The content type.