Package com.gengoai.io.resource

Class BaseResource

java.lang.Object

com.gengoai.io.resource.BaseResource

All Implemented Interfaces:

Resource, Serializable

Direct Known Subclasses:

ByteArrayResource, ClasspathResource, EmptyResource, FileResource, InputStreamResource, OutputStreamResource, ReaderResource, StdinResource, StdoutResource, StringResource, URIResource, URLResource, WriterResource, ZipResource

public abstract class BaseResource
extends Object
implements Resource, Serializable

Abstract base resource

Author:

David B. Bracewell

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.gengoai.io.resource.Resource

Resource.Deserializer

Field Summary

Fields inherited from interface com.gengoai.io.resource.Resource

ALL_FILE_PATTERN

Constructor Summary

Constructors

Constructor	Description
BaseResource()

Method Summary

Modifier and Type	Method	Description
Optional<File>	asFile()	Gets the resource as a File.
Optional<URI>	asURI()	As uri optional.
String	baseName()	Gets the name (file name or directory name) of this resource.
boolean	canRead()	Returns true if the resource is readable, false if not.
boolean	canWrite()	Returns true if the resource is writable, false if not.
Resource	compressed()	Sets is compressed.
protected InputStream	createInputStream()	Create input stream input stream.
protected OutputStream	createOutputStream()	Create output stream output stream.
String	descriptor()	Descriptor string.
Charset	getCharset()	Gets the charset for reading and writing.
InputStream	inputStream()	Opens an input stream over this resource.
boolean	isCompressed()	Is compressed.
boolean	isDirectory()	Is directory.
OutputStream	outputStream()	Opens an output stream over this resource.
String	path()	Gets path in the same mannar as File.getPath()
Resource	setCharset(Charset charset)	Sets the charset for reading and writing.
Resource	setCompression(Compression compression)	Sets the compression algorithm.
Resource	setIsCompressed(boolean isCompressed)	Sets is compressed.
String	toString()
Resource	uncompressed()	Uncompressed resource.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.gengoai.io.resource.Resource

append, append, asPath, asURL, childIterator, childIterator, copy, delete, delete, deleteOnExit, exists, forEach, getChild, getChildren, getChildren, getChildren, getChildren, getChildren, getParent, lines, mkdir, mkdirs, readBytes, reader, readLines, readObject, readToString, write, write, writeObject, writer

Constructor Detail

BaseResource

public BaseResource()

Method Detail

asFile

public Optional<File> asFile()

Description copied from interface: Resource

Gets the resource as a File.

Specified by:

asFile in interface Resource

Returns:

A File representing the resource.

asURI

public Optional<URI> asURI()

Description copied from interface: Resource

As uri optional.

Specified by:

asURI in interface Resource

Returns:

the optional

baseName

public String baseName()

Description copied from interface: Resource

Gets the name (file name or directory name) of this resource.

Specified by:

baseName in interface Resource

Returns:

The name of the file or directory

canRead

public boolean canRead()

Description copied from interface: Resource

Returns true if the resource is readable, false if not.

Specified by:

canRead in interface Resource

Returns:

True if can read from the resource

canWrite

public boolean canWrite()

Description copied from interface: Resource

Returns true if the resource is writable, false if not.

Specified by:

canWrite in interface Resource

Returns:

True if can write to the resource

compressed

public final Resource compressed()

Description copied from interface: Resource

Sets is compressed.

Specified by:

compressed in interface Resource

Returns:

the resource

createInputStream

protected InputStream createInputStream()
                                 throws IOException

Create input stream input stream.

Returns:

the input stream

Throws:

IOException - the io exception

createOutputStream

protected OutputStream createOutputStream()
                                   throws IOException

Create output stream output stream.

Returns:

the output stream

Throws:

IOException - the io exception

descriptor

public String descriptor()

Description copied from interface: Resource

Descriptor string.

Specified by:

descriptor in interface Resource

Returns:

The string representation of the resource with protocol

getCharset

public final Charset getCharset()

Description copied from interface: Resource

Gets the charset for reading and writing. The charset if not specified will be automatically determined during read.

Specified by:

getCharset in interface Resource

Returns:

The charset used for writing and default when reading

inputStream

public InputStream inputStream()
                        throws IOException

Description copied from interface: Resource

Opens an input stream over this resource.

Specified by:

inputStream in interface Resource

Returns:

An input stream over this resource.

Throws:

IOException - the io exception

isCompressed

public final boolean isCompressed()

Description copied from interface: Resource

Is compressed.

Specified by:

isCompressed in interface Resource

Returns:

True if the resources is gzipped compressed

isDirectory

public boolean isDirectory()

Description copied from interface: Resource

Is directory.

Specified by:

isDirectory in interface Resource

Returns:

True if the resource is a directory

outputStream

public OutputStream outputStream()
                          throws IOException

Description copied from interface: Resource

Opens an output stream over this resource.

Specified by:

outputStream in interface Resource

Returns:

An output stream over this resource.

Throws:

IOException - the io exception

path

public String path()

Description copied from interface: Resource

Gets path in the same mannar as File.getPath()

Specified by:

path in interface Resource

Returns:

The full path to the resource including name

setCharset

public final Resource setCharset(Charset charset)

Description copied from interface: Resource

Sets the charset for reading and writing.

Specified by:

setCharset in interface Resource

Parameters:

charset - The charset to use

Returns:

the charset

setCompression

public Resource setCompression(Compression compression)

Description copied from interface: Resource

Sets the compression algorithm.

Specified by:

setCompression in interface Resource

Parameters:

compression - the compression algorithm

Returns:

this Resource

setIsCompressed

public final Resource setIsCompressed(boolean isCompressed)

Description copied from interface: Resource

Sets is compressed.

Specified by:

setIsCompressed in interface Resource

Parameters:

isCompressed - the is compressed

Returns:

the is compressed

toString

public final String toString()

Overrides:

toString in class Object

uncompressed

public final Resource uncompressed()

Description copied from interface: Resource

Uncompressed resource.

Specified by:

uncompressed in interface Resource

Returns:

the resource