org.jabref.model.ai.summarization

public final Record AiSummary

Class Inheritance

extends Record

java.lang.Object
java.lang.Record
org.jabref.model.ai.summarization.AiSummary

Record Components

metadata:AiMetadata
summarizationAlgorithm:SummarizatorKind
content:String

Imports

org.jabref.model.ai.AiMetadata, com.fasterxml.jackson.annotation.JsonCreator, .JsonProperty

Field Summary

Modifier and Type	Field and Description
private final String	content Record Component accessed by content().
private final AiMetadata	metadata Record Component accessed by metadata().
private final SummarizatorKind	summarizationAlgorithm Record Component accessed by summarizationAlgorithm().

Constructor Summary

Access	Constructor and Description
public	AiSummary(AiMetadata metadata, SummarizatorKind summarizationAlgorithm, String content)

Method Summary

Modifier and Type	Method and Description
public String	content() Record Component getter of content.
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 AiMetadata	metadata() Record Component getter of metadata.
public SummarizatorKind	summarizationAlgorithm() Record Component getter of summarizationAlgorithm.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

content	back to summary
private final String content Record Component accessed by content().

metadata	back to summary
private final AiMetadata metadata Record Component accessed by metadata().

summarizationAlgorithm	back to summary
private final SummarizatorKind summarizationAlgorithm Record Component accessed by summarizationAlgorithm().

Constructor Detail

AiSummary	back to summary
public AiSummary(AiMetadata metadata, SummarizatorKind summarizationAlgorithm, String content) Annotations @JsonCreator

Method Detail

content	back to summary
public String content() Record Component getter of content.

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.

metadata	back to summary
public AiMetadata metadata() Record Component getter of metadata.

summarizationAlgorithm	back to summary
public SummarizatorKind summarizationAlgorithm() Record Component getter of summarizationAlgorithm.

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.