Package org.apache.juneau.http.classic.resource

Class FileResource

java.lang.Object

org.apache.juneau.http.classic.resource.BasicResource<FileResource>

org.apache.juneau.http.classic.resource.FileResource

All Implemented Interfaces:

HttpEntity, HttpResource

Direct Known Subclasses:

FileResource.Unmodifiable

public class FileResource
extends BasicResource<FileResource>

A repeatable resource that obtains its content from a File.

See Also:

• juneau-rest-common

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FileResource.Unmodifiable	An unmodifiable snapshot of a FileResource.

Constructor Summary

Constructors

Modifier	Constructor	Description
	FileResource()	Constructor.
	FileResource(ContentType contentType, File contents)	Constructor.
protected	FileResource(FileResource copyFrom)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
FileResource	copy()	Creates a builder for this class initialized with the contents of this bean.
FileResource	unmodifiable()	Returns an unmodifiable snapshot of this bean.

Methods inherited from class org.apache.juneau.http.classic.resource.BasicResource

addHeader, addHeaders, asBytes, assertBytes, assertString, asString, consumeContent, copyFrom, freeze, getContent, getContentEncoding, getContentLength, getContentType, getEntity, getHeaders, isChunked, isRepeatable, isStreaming, isUnmodifiable, modify, self, setCached, setChunked, setChunked, setContent, setContent, setContentEncoding, setContentEncoding, setContentLength, setContentType, setContentType, setHeader, setHeaders, setHeaders, writeTo

Methods inherited from class java.lang.Object

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

Constructor Details

FileResource

public FileResource()

Constructor.

FileResource

public FileResource(ContentType contentType,
 File contents)

Constructor.

Parameters:

contentType - The entity content type. Can be null to omit an explicit Content-Type header.

contents - The entity contents. Can be null, in which case a NullPointerException is thrown when the resource's content is read.

FileResource

protected FileResource(FileResource copyFrom)

Copy constructor.

Parameters:

copyFrom - The bean being copied. Must not be null.

Method Details

copy

public FileResource copy()

Description copied from class: BasicResource

Creates a builder for this class initialized with the contents of this bean.

Allows you to create a modifiable copy of this bean.

Specified by:

copy in class BasicResource<FileResource>

Returns:

A new builder bean.

unmodifiable

public FileResource unmodifiable()

Description copied from class: BasicResource

Returns an unmodifiable snapshot of this bean.

Idempotency: if this bean is already an unmodifiable snapshot, it is returned as-is.

Specified by:

unmodifiable in class BasicResource<FileResource>

Returns:

An unmodifiable snapshot of this bean, or this bean if it is already unmodifiable.