Record Class DocumentMetadata

java.lang.Object

java.lang.Record

ai.doctruth.DocumentMetadata

Record Components:

sourceFilename - the original filename of the source document.

pageCount - total number of pages in the source document; >= 1.

sourcePublishedAt - UTC timestamp at which the source was authored, if known.

public record DocumentMetadata(String sourceFilename, int pageCount, Optional<Instant> sourcePublishedAt)
extends Record

Metadata for a ParsedDocument: the source filename, total page count, and (optionally) the timestamp at which the source document was authored / published.

Invariants (enforced by the compact constructor):

• sourceFilename is non-null and non-blank (any whitespace-only string rejected).
• pageCount >= 1.
• sourcePublishedAt is a non-null Optional; pass Optional.empty(), not null, when unknown.

Since:

0.1.0

Constructor Summary

Constructors

Constructor	Description
DocumentMetadata(String sourceFilename, int pageCount, Optional<Instant> sourcePublishedAt)	Creates an instance of a DocumentMetadata record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
int	pageCount()	Returns the value of the pageCount record component.
String	sourceFilename()	Returns the value of the sourceFilename record component.
Optional<Instant>	sourcePublishedAt()	Returns the value of the sourcePublishedAt record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

DocumentMetadata

public DocumentMetadata(String sourceFilename,
 int pageCount,
 Optional<Instant> sourcePublishedAt)

Creates an instance of a DocumentMetadata record class.

Parameters:

sourceFilename - the value for the sourceFilename record component

pageCount - the value for the pageCount record component

sourcePublishedAt - the value for the sourcePublishedAt record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

sourceFilename

public String sourceFilename()

Returns the value of the sourceFilename record component.

Returns:

the value of the sourceFilename record component

pageCount

public int pageCount()

Returns the value of the pageCount record component.

Returns:

the value of the pageCount record component

sourcePublishedAt

public Optional<Instant> sourcePublishedAt()

Returns the value of the sourcePublishedAt record component.

Returns:

the value of the sourcePublishedAt record component