org.archive.io

Interface ReplayCharSequence

All Superinterfaces:

AutoCloseable, CharSequence, Closeable

All Known Implementing Classes:

GenericReplayCharSequence

public interface ReplayCharSequence
extends CharSequence, Closeable

CharSequence interface with addition of a close() method. Users of implementations of this interface must call close() so implementations get a chance at cleaning up after themselves.

Version:

$Revision$, $Date$

Author:

stack

Field Summary

Fields

Modifier and Type	Field and Description
static Charset	FALLBACK_CHARSET charset to use in replay when declared value is absent/illegal/unavailable

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Call this method when done so implementation has chance to clean up resources.
Charset	getCharset() Return the effective Charset used to create this CharSequence from (raw byte) source material.
CharacterCodingException	getCodingException() Return the first coding-exception encountered, if the count > 0.
long	getDecodeExceptionCount() Report count of decoder errors silently eaten during ReplayCharSequence use.
boolean	isOpen()

Methods inherited from interface java.lang.CharSequence

charAt, length, subSequence, toString

Field Detail

FALLBACK_CHARSET

static final Charset FALLBACK_CHARSET

charset to use in replay when declared value is absent/illegal/unavailable

Method Detail

close

void close()
           throws IOException

Call this method when done so implementation has chance to clean up resources.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException - Problem cleaning up file system resources.

getDecodeExceptionCount

long getDecodeExceptionCount()

Report count of decoder errors silently eaten during ReplayCharSequence use. May be less than the number of individual decoding anomalies in underlying content (if decoding method doesn't allow counting individual errors).

getCodingException

CharacterCodingException getCodingException()

Return the first coding-exception encountered, if the count > 0.

Returns:

CharacterCodingException

isOpen

boolean isOpen()

Returns:

false if close() has been called

getCharset

Charset getCharset()

Return the effective Charset used to create this CharSequence from (raw byte) source material.