ch.awae.utils.source

Class Source

java.lang.Object

ch.awae.utils.source.Source

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public abstract class Source
extends java.lang.Object
implements java.io.Closeable

Source Data interaction Helper Designed to enable interaction with different data sources as simple one-liners

Since:

awaeUtils 1.0.0

Author:

Andreas Wälchli

Constructor Summary

Constructors

Constructor and Description
Source()

Method Summary

Modifier and Type	Method and Description
static Source	fromFile(java.lang.String file) Returns a Source based of the given file name.
static Source	fromStream(java.io.InputStream stream) Returns a Source based of the given input stream This method does not validate the given stream.
static Source	fromURL(java.lang.String url) Returns a Source based of the given URL.
abstract Result<java.io.InputStream>	mkStream() Returns the Source as an input stream
Result<java.lang.String>	mkString() reads the source into a string
Result<XML>	mkXML() reads the source into an XML document

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Closeable

close

Constructor Detail

Source

public Source()

Method Detail

fromFile

public static Source fromFile(java.lang.String file)

Returns a Source based of the given file name.
This method does not validate the given file name. It is implicitly validated as soon as it is interacted with. This allows for clearer Source handling.

Parameters:

file - the file name

Returns:

a source based off the given file

fromStream

public static Source fromStream(java.io.InputStream stream)

Returns a Source based of the given input stream
This method does not validate the given stream. It is implicitly validated as soon as it is interacted with. This allows for clearer Source handling.

Parameters:

stream - the input stream

Returns:

a source based off the given stream

fromURL

public static Source fromURL(java.lang.String url)

Returns a Source based of the given URL.
This method does not validate the given URL. It is implicitly validated as soon as it is interacted with. This allows for clearer Source handling.

Parameters:

url - the source url

Returns:

a source based off the given url

mkStream

public abstract Result<java.io.InputStream> mkStream()

Returns the Source as an input stream

Returns:

a Result holding the stream or any potential exception

mkString

public Result<java.lang.String> mkString()

reads the source into a string

Returns:

a Result holding the string or any potential exception

mkXML

public Result<XML> mkXML()

reads the source into an XML document

Returns:

a result holding the XML