Module kivakit.resource

Package com.telenav.kivakit.resource.reading

Class BaseReadableResource

java.lang.Object

com.telenav.kivakit.core.messaging.broadcasters.Multicaster

com.telenav.kivakit.core.messaging.repeaters.BaseRepeater

com.telenav.kivakit.resource.reading.BaseReadableResource

All Implemented Interfaces:

Broadcaster, Listener, Repeater, Transceiver, CreatedAt, Modifiable, ModifiedAt, ByteSized, Receiver, Transmitter, NamedObject, StringSource, Deletable, Readable, ReadableResource, Resource, Resourceful, ResourcePathed, UriIdentified

Direct Known Subclasses:

BaseNetworkResource, BaseWritableResource, InputResource, PackageResource, ResourceSection, StringResource

public abstract class BaseReadableResource
extends BaseRepeater
implements Resource

A base implementation of the Resource interface. Adds the following methods:

• codec(Codec) - Applies a Codec to this resource

All other methods are documented in the Resource superinterface.

Nested Class Summary

Nested classes/interfaces inherited from interface com.telenav.kivakit.resource.Resource

Resource.Can, Resource.Converter

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseReadableResource()	For serialization
protected	BaseReadableResource(BaseReadableResource that)
protected	BaseReadableResource(ResourcePath path)

Method Summary

Modifier and Type	Method	Description
final Charset	charset()
protected void	charset(Charset charset)
Codec	codec()
BaseReadableResource	codec(Codec codec)
void	copyTo(WritableResource destination, CopyMode mode, ProgressReporter reporter)	Copies the data in this resource to the destination.
boolean	delete()	Returns true if the object was deleted, false otherwise
void	dematerialize()	Remove any materialized local copy if this is a remote resource that's been cached
boolean	equals(Object object)
boolean	exists()
int	hashCode()
Resource	materialized(ProgressReporter reporter)
InputStream	openForReading(ProgressReporter reporter)	Opens something that can be read, returning an input stream.
ResourcePath	path()	StringPath to this resource
String	toString()

Methods inherited from class com.telenav.kivakit.core.messaging.repeaters.BaseRepeater

onMessage, onReceive

Methods inherited from class com.telenav.kivakit.core.messaging.broadcasters.Multicaster

addListener, clearListeners, debugClassContext, debugCodeContext, debugCodeContext, hasListeners, isDeaf, isTransmitting, listenerChain, listeners, listenerTree, messageSource, messageSource, objectName, removeListener, transmit, withoutTransmitting

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.telenav.kivakit.core.messaging.Broadcaster

addListener, addListener, clearListeners, copyListeners, hasListeners, listeners, messageSource, messageSource, onTransmit, onTransmitted, onTransmitting, removeListener, silence, transmit, transmit, transmitAll

Methods inherited from interface com.telenav.kivakit.core.value.count.ByteSized

isLargerThan, isSmallerThan

Methods inherited from interface com.telenav.kivakit.core.time.CreatedAt

age, createdAt, wasCreatedAfter, wasCreatedBefore

Methods inherited from interface com.telenav.kivakit.core.messaging.Listener

isDeaf, listenTo, listenTo, onMessage

Methods inherited from interface com.telenav.kivakit.core.time.Modifiable

lastModified

Methods inherited from interface com.telenav.kivakit.core.time.ModifiedAt

modifiedAt, wasChangedAfter, wasChangedBefore

Methods inherited from interface com.telenav.kivakit.interfaces.naming.NamedObject

hasSyntheticName, objectName, objectName

Methods inherited from interface com.telenav.kivakit.resource.reading.Readable

isReadable, onOpenForReading, openForReading, sizeInBytes

Methods inherited from interface com.telenav.kivakit.resource.reading.ReadableResource

asStringResource, reader, reader, reader

Methods inherited from interface com.telenav.kivakit.interfaces.messaging.Receiver

isReceiving

Methods inherited from interface com.telenav.kivakit.core.messaging.Repeater

isRepeating, onReceive, receive

Methods inherited from interface com.telenav.kivakit.resource.Resource

asString, asWritable, can, can, endsWith, ensureExists, hasParent, isEmpty, isLocal, isMaterializable, isOlderThan, isPackaged, isRemote, isSame, parent, relativeTo, renameTo, resource, safeCopyTo, safeCopyTo, safeCopyTo, safeCopyTo

Methods inherited from interface com.telenav.kivakit.resource.ResourcePathed

asJavaFile, baseName, compoundExtension, extension, fileName, hasExtension, matches, uri, url

Methods inherited from interface com.telenav.kivakit.core.messaging.Transceiver

announce, debug, debugClassContext, debugCodeContext, debugCodeContext, fatal, fatal, glitch, glitch, glitch, glitch, halted, halted, ifDebug, illegalArgument, illegalState, illegalState, information, isDebugOn, narrate, problem, problem, problem, problem, problemIfNull, quibble, quibble, quibble, quibble, trace, trace, trace, trace, warning, warning, warning, warning

Methods inherited from interface com.telenav.kivakit.interfaces.messaging.Transmitter

isTransmitting, withoutTransmitting

Constructor Details

BaseReadableResource

protected BaseReadableResource()

For serialization

BaseReadableResource

protected BaseReadableResource(ResourcePath path)

BaseReadableResource

protected BaseReadableResource(BaseReadableResource that)

Method Details

charset

public final Charset charset()

Specified by:

charset in interface ReadableResource

Returns:

The charset used by this resource

codec

public Codec codec()

Specified by:

codec in interface Resource

Returns:

Any codec for compression / decompression

codec

public BaseReadableResource codec(Codec codec)

copyTo

public void copyTo(WritableResource destination,
 CopyMode mode,
 ProgressReporter reporter)

Copies the data in this resource to the destination.

Specified by:

copyTo in interface ReadableResource

Parameters:

destination - The destination to write to

delete

public boolean delete()

Description copied from interface: Deletable

Returns true if the object was deleted, false otherwise

Specified by:

delete in interface Deletable

dematerialize

public void dematerialize()

Remove any materialized local copy if this is a remote resource that's been cached

Specified by:

dematerialize in interface Resource

equals

public boolean equals(Object object)

Overrides:

equals in class Object

exists

public boolean exists()

Specified by:

exists in interface Resource

Returns:

True if the resource exists

hashCode

public int hashCode()

Overrides:

hashCode in class Object

materialized

public Resource materialized(ProgressReporter reporter)

Specified by:

materialized in interface Resource

Returns:

A local cached copy of this resource if it is remote.

openForReading

public InputStream openForReading(ProgressReporter reporter)

Description copied from interface: Readable

Opens something that can be read, returning an input stream. The given progress reporter is called for each byte that is read from the input stream. If the input size is known (meaning that Readable.sizeInBytes() returns a non-null value), the reporter will be initialized with the number of bytes to allow percent completion to be computed as the stream is read.

Specified by:

openForReading in interface Readable

Parameters:

reporter - A progress reporter that is called for each byte that is read

Returns:

The input stream to read from

path

public ResourcePath path()

Description copied from interface: Resource

StringPath to this resource

Specified by:

path in interface Resource

Specified by:

path in interface ResourcePathed

Returns:

The path to this object

toString

public String toString()

Overrides:

toString in class Object

charset

protected void charset(Charset charset)