Modifier and Type	Class and Description
public static record	OcrResult.Failure Represents a failed OCR result.
public static record	OcrResult.Success Represents a successful OCR result.

Modifier and Type	Method and Description
public static OcrResult	failure(OcrFailureReason reason) Factory method to create a failure result with an error message.
public default boolean	isFailure() Checks if this result is failure.
public default boolean	isSuccess() Checks if this result is success.
public static OcrResult	success(Path outputFile) Factory method to create a success result with text and output file.

failure	back to summary
public static OcrResult failure(OcrFailureReason reason) Factory method to create a failure result with an error message.

isFailure	back to summary
public default boolean isFailure() Checks if this result is failure.

isSuccess	back to summary
public default boolean isSuccess() Checks if this result is success.

success	back to summary
public static OcrResult success(Path outputFile) Factory method to create a success result with text and output file.

org.jabref.logic.ocr back to summary

public final Record OcrResult.Failure

Class Inheritance

extends Record
implements OcrResult

java.lang.Object
java.lang.Record
org.jabref.logic.ocr.OcrResult.Failure

All Implemented Interfaces

org.jabref.logic.ocr.OcrResult

Record Components

reason:OcrFailureReason

Represents a failed OCR result.

Contains the reason why the failure occurred that the GUI part can localize it and output to the user.

Field Summary

Modifier and Type	Field and Description
private final OcrFailureReason	reason Record Component accessed by reason().

Constructor Summary

Access	Constructor and Description
public	Failure(OcrFailureReason reason)

Method Summary

Modifier and Type	Method and Description
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public OcrFailureReason	reason() Record Component getter of reason.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

reason	back to summary
private final OcrFailureReason reason Record Component accessed by reason().

Constructor Detail

Failure	back to summary
public Failure(OcrFailureReason reason)

Method Detail

equals back to summary

equals	back to summary
public final boolean equals(Object o) Implements abstract java.lang.Record.equals. Doc from java.lang.Record.equals. Indicates whether some other object is "equal to" this one. In addition to the general contract of `Object.equals`, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows: R copy = new R(r.c1(), r.c2(), ..., r.cn()); then it must be the case that `r.equals(copy)`.

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows:

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

hashCode back to summary

hashCode	back to summary
public final int hashCode() Implements abstract java.lang.Record.hashCode. Doc from java.lang.Record.hashCode. Returns a hash code value for the record. Obeys the general contract of `Object.hashCode`. For records, hashing behavior is constrained by the refined contract of `Record.equals`, so that any two records created from the same components must have the same hash code.

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

reason	back to summary
public OcrFailureReason reason() Record Component getter of reason.

toString back to summary

toString	back to summary
public final String toString() Implements abstract java.lang.Record.toString. Doc from java.lang.Record.toString. Returns a string representation of the record. In accordance with the general contract of `Object#toString()`, the `toString` method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read. In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

org.jabref.logic.ocr back to summary

public final Record OcrResult.Success

Class Inheritance

extends Record
implements OcrResult

java.lang.Object
java.lang.Record
org.jabref.logic.ocr.OcrResult.Success

All Implemented Interfaces

org.jabref.logic.ocr.OcrResult

Record Components

outputFile:Path

Represents a successful OCR result.

Contains the path of the searchable PDF created by the OCR engine.

Field Summary

Modifier and Type	Field and Description
private final Path	outputFile Record Component accessed by outputFile().

Constructor Summary

Access	Constructor and Description
public	Success(Path outputFile)

Method Summary

Modifier and Type	Method and Description
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public Path	outputFile() Record Component getter of outputFile.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

outputFile	back to summary
private final Path outputFile Record Component accessed by outputFile().

Constructor Detail

Success	back to summary
public Success(Path outputFile)

Method Detail

equals back to summary

equals	back to summary
public final boolean equals(Object o) Implements abstract java.lang.Record.equals. Doc from java.lang.Record.equals. Indicates whether some other object is "equal to" this one. In addition to the general contract of `Object.equals`, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows: R copy = new R(r.c1(), r.c2(), ..., r.cn()); then it must be the case that `r.equals(copy)`.

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

hashCode back to summary

hashCode	back to summary
public final int hashCode() Implements abstract java.lang.Record.hashCode. Doc from java.lang.Record.hashCode. Returns a hash code value for the record. Obeys the general contract of `Object.hashCode`. For records, hashing behavior is constrained by the refined contract of `Record.equals`, so that any two records created from the same components must have the same hash code.

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

outputFile	back to summary
public Path outputFile() Record Component getter of outputFile.

toString back to summary

toString	back to summary
public final String toString() Implements abstract java.lang.Record.toString. Doc from java.lang.Record.toString. Returns a string representation of the record. In accordance with the general contract of `Object#toString()`, the `toString` method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read. In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

public sealed Interface OcrResult

Nested and Inner Type Summary

Method Summary

Method Detail

public final Record OcrResult.Failure

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Record OcrResult.Success

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail