Verified Owner
Top Description Fields Constructors Methods
org.jabref.logic.relatedwork

public final Record RelatedWorkSnippet

extends Record
Class Inheritance
Record Components
contextText:String 
citationMarker:String 
Snippet extracted from a related work section

Example: original text: "Unlike Smith et al. 10, our approach uses..." contextText: "Unlike Smith et al., our approach uses..." citationMarker: "10"

Field Summary

Modifier and TypeField and Description
private final String
citationMarker

Record Component accessed by citationMarker().

private final String
contextText

Record Component accessed by contextText().

Constructor Summary

AccessConstructor and Description
public
RelatedWorkSnippet(String contextText, String citationMarker)

Method Summary

Modifier and TypeMethod and Description
public String
citationMarker()

Record Component getter of citationMarker.

public String
contextText()

Record Component getter of contextText.

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 final String
toString()

Implements abstract java.lang.Record.toString.

Returns a string representation of the record.

Field Detail

citationMarkerback to summary
private final String citationMarker

Record Component accessed by citationMarker().

contextTextback to summary
private final String contextText

Record Component accessed by contextText().

Constructor Detail

RelatedWorkSnippetback to summary
public RelatedWorkSnippet(String contextText, String citationMarker)

Method Detail

citationMarkerback to summary
public String citationMarker()

Record Component getter of citationMarker.

contextTextback to summary
public String contextText()

Record Component getter of contextText.

equalsback 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).
hashCodeback 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.

toStringback 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.