Verified Owner
Top Fields Constructors Methods
org.jabref.logic.openoffice

public final Record JabRefReferenceMark

extends Record
implements ReferenceMark
Class Inheritance
All Implemented Interfaces
org.jabref.logic.openoffice.ReferenceMark
Annotations
@NullMarked
Record Components
name:String 
citationKeys:List<String> 
citationNumbers:List<Integer> 
uniqueId:String 
citationType:CSLCitationType 
Imports
java.util.ArrayList, .List, .Optional, java.util.regex.Matcher, .Pattern, org.jabref.logic.openoffice.oocsltext.CSLCitationType, org.jspecify.annotations.NullMarked

Field Summary

Modifier and TypeField and Description
private final List<String>
citationKeys

Record Component accessed by citationKeys().

private final List<Integer>
citationNumbers

Record Component accessed by citationNumbers().

private final CSLCitationType
citationType

Record Component accessed by citationType().

public static final String
EMPTY_MARKER

private static final Pattern
ENTRY_PATTERN

public static final String
IN_TEXT_MARKER

private final String
name

Record Component accessed by name().

public static final String
NORMAL_MARKER

public static final String[]
PREFIXES

private static final Pattern
REFERENCE_MARK_FORMAT

e.g. "JABREF_Smith_2020 CID_1 abcd1234 NORMAL"

private final String
uniqueId

Record Component accessed by uniqueId().

Constructor Summary

AccessConstructor and Description
public
JabRefReferenceMark(String name, List<String> citationKeys, List<Integer> citationNumbers, String uniqueId, CSLCitationType citationType)

Method Summary

Modifier and TypeMethod and Description
public static JabRefReferenceMark
buildReferenceMark(List<String> citationKeys, List<Integer> citationNumbers, CSLCitationType citationType)

public static String
buildReferenceMarkName(List<String> citationKeys, List<Integer> citationNumbers, String uniqueId, CSLCitationType citationType)

public List<String>
citationKeys()

Record Component getter of citationKeys.

Implements org.jabref.logic.openoffice.ReferenceMark.citationKeys.

public List<Integer>
citationNumbers()

Record Component getter of citationNumbers.

Implements org.jabref.logic.openoffice.ReferenceMark.citationNumbers.

public CSLCitationType
citationType()

Record Component getter of citationType.

Implements org.jabref.logic.openoffice.ReferenceMark.citationType.

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 static boolean
isJabRefReferenceMarkName(String name)

Hides org.jabref.logic.openoffice.ReferenceMark.isJabRefReferenceMarkName.

public String
name()

Record Component getter of name.

Implements org.jabref.logic.openoffice.ReferenceMark.name.

public static Optional<JabRefReferenceMark>
parse(String name)

Hides org.jabref.logic.openoffice.ReferenceMark.parse.

public final String
toString()

Implements abstract java.lang.Record.toString.

Returns a string representation of the record.

public String
uniqueId()

Record Component getter of uniqueId.

Implements org.jabref.logic.openoffice.ReferenceMark.uniqueId.

Field Detail

citationKeysback to summary
private final List<String> citationKeys

Record Component accessed by citationKeys().

citationNumbersback to summary
private final List<Integer> citationNumbers

Record Component accessed by citationNumbers().

citationTypeback to summary
private final CSLCitationType citationType

Record Component accessed by citationType().

EMPTY_MARKERback to summary
public static final String EMPTY_MARKER
ENTRY_PATTERNback to summary
private static final Pattern ENTRY_PATTERN
IN_TEXT_MARKERback to summary
public static final String IN_TEXT_MARKER
nameback to summary
private final String name

Record Component accessed by name().

NORMAL_MARKERback to summary
public static final String NORMAL_MARKER
PREFIXESback to summary
public static final String[] PREFIXES
REFERENCE_MARK_FORMATback to summary
private static final Pattern REFERENCE_MARK_FORMAT

e.g. "JABREF_Smith_2020 CID_1 abcd1234 NORMAL"

uniqueIdback to summary
private final String uniqueId

Record Component accessed by uniqueId().

Constructor Detail

JabRefReferenceMarkback to summary
public JabRefReferenceMark(String name, List<String> citationKeys, List<Integer> citationNumbers, String uniqueId, CSLCitationType citationType)

Method Detail

buildReferenceMarkback to summary
public static JabRefReferenceMark buildReferenceMark(List<String> citationKeys, List<Integer> citationNumbers, CSLCitationType citationType)
buildReferenceMarkNameback to summary
public static String buildReferenceMarkName(List<String> citationKeys, List<Integer> citationNumbers, String uniqueId, CSLCitationType citationType)
citationKeysback to summary
public List<String> citationKeys()

Record Component getter of citationKeys.

Implements org.jabref.logic.openoffice.ReferenceMark.citationKeys.

citationNumbersback to summary
public List<Integer> citationNumbers()

Record Component getter of citationNumbers.

Implements org.jabref.logic.openoffice.ReferenceMark.citationNumbers.

citationTypeback to summary
public CSLCitationType citationType()

Record Component getter of citationType.

Implements org.jabref.logic.openoffice.ReferenceMark.citationType.

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.

isJabRefReferenceMarkNameback to summary
public static boolean isJabRefReferenceMarkName(String name)

Hides org.jabref.logic.openoffice.ReferenceMark.isJabRefReferenceMarkName.

nameback to summary
public String name()

Record Component getter of name.

Implements org.jabref.logic.openoffice.ReferenceMark.name.

parseback to summary
public static Optional<JabRefReferenceMark> parse(String name)

Hides org.jabref.logic.openoffice.ReferenceMark.parse.

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.

uniqueIdback to summary
public String uniqueId()

Record Component getter of uniqueId.

Implements org.jabref.logic.openoffice.ReferenceMark.uniqueId.