Class StaleMetadataException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.io.IOException

dev.hardwood.reader.StaleMetadataException

All Implemented Interfaces:

Serializable

@Experimental
public class StaleMetadataException
extends IOException

Raised when the footer a MetadataSource supplied does not describe the file being read.

The file itself is intact. Evicting the footer the source served for the file and opening a new reader, so that the source reads the footer afresh, is the remedy. For a cache keyed on the file's name and the identity its footer was read with:

try {
    read(path);
}
catch (StaleMetadataException e) {
    e.sourceIdentity().ifPresent(id -> cache.remove(new FooterKey(e.fileName(), id)));
    read(path);
}

The reader raises it before reading any data of the file.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	StaleMetadataException.Check	The check the supplied footer failed.

Constructor Summary

Constructors

Constructor	Description
StaleMetadataException(String fileName, StaleMetadataException.Check check, Optional<String> sourceIdentity, Optional<String> fileIdentity, String detail)

Method Summary

Modifier and Type	Method	Description
StaleMetadataException.Check	check()	The check the supplied footer failed.
Optional<String>	fileIdentity()	The identity of the file being read; empty when it has none.
String	fileName()	The InputFile.name() of the file being read.
Optional<String>	sourceIdentity()	The identity of the file the supplied footer was read from; empty when it had none.

Methods inherited from class Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class Object

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

Constructor Details

StaleMetadataException

public StaleMetadataException(String fileName,
 StaleMetadataException.Check check,
 Optional<String> sourceIdentity,
 Optional<String> fileIdentity,
 String detail)

Parameters:

fileName - the InputFile.name() of the file being read

check - the check the footer failed

sourceIdentity - the footer's ParsedFooter.sourceIdentity()

fileIdentity - the file's InputFile.identity()

detail - what the check found

Method Details

fileName

public String fileName()

The InputFile.name() of the file being read.

check

public StaleMetadataException.Check check()

The check the supplied footer failed.

sourceIdentity

public Optional<String> sourceIdentity()

The identity of the file the supplied footer was read from; empty when it had none.

fileIdentity

public Optional<String> fileIdentity()

The identity of the file being read; empty when it has none.