Verified Owner
Top Description Fields Constructors Methods
org.jabref.logic.shared.notifications

public final Record FieldChange

extends Record
Class Inheritance
Annotations
@NullMarked
Record Components
sourceProcessorId:String 
bibEntryId:@Nullable String 
field:@Nullable String 
oldValue:@Nullable String 
newValue:@Nullable String 
version:int
the entry's version after the change, as assigned by the database
Imports
org.jspecify.annotations.NullMarked, .Nullable

Payload of a jabrefLiveUpdate notification.

If field is null, the change content did not fit into the payload (or was not safe to send) and receivers pull from the database instead.

Field Summary

Modifier and TypeField and Description
private final @Nullable String
bibEntryId

Record Component accessed by bibEntryId().

private final @Nullable String
field

Record Component accessed by field().

private final @Nullable String
newValue

Record Component accessed by newValue().

private final @Nullable String
oldValue

Record Component accessed by oldValue().

private final String
sourceProcessorId

Record Component accessed by sourceProcessorId().

private final int
version

Record Component accessed by version().

the entry's version after the change, as assigned by the database

Constructor Summary

AccessConstructor and Description
public
FieldChange(String sourceProcessorId, @Nullable String bibEntryId, @Nullable String field, @Nullable String oldValue, @Nullable String newValue, int version)

Method Summary

Modifier and TypeMethod and Description
public @Nullable String
bibEntryId()

Record Component getter of bibEntryId.

public final boolean
equals(Object o)

Implements abstract java.lang.Record.equals.

Indicates whether some other object is "equal to" this one.

public @Nullable String
field()

Record Component getter of field.

public final int
hashCode()

Implements abstract java.lang.Record.hashCode.

Returns a hash code value for the record.

public @Nullable String
newValue()

Record Component getter of newValue.

public @Nullable String
oldValue()

Record Component getter of oldValue.

public String
sourceProcessorId()

Record Component getter of sourceProcessorId.

public final String
toString()

Implements abstract java.lang.Record.toString.

Returns a string representation of the record.

public int
version()

Record Component getter of version.

Record Component the entry's version after the change, as assigned by the database

Field Detail

bibEntryIdback to summary
private final @Nullable String bibEntryId

Record Component accessed by bibEntryId().

fieldback to summary
private final @Nullable String field

Record Component accessed by field().

newValueback to summary
private final @Nullable String newValue

Record Component accessed by newValue().

oldValueback to summary
private final @Nullable String oldValue

Record Component accessed by oldValue().

sourceProcessorIdback to summary
private final String sourceProcessorId

Record Component accessed by sourceProcessorId().

versionback to summary
private final int version

Record Component accessed by version().

the entry's version after the change, as assigned by the database

Constructor Detail

FieldChangeback to summary
public FieldChange(String sourceProcessorId, @Nullable String bibEntryId, @Nullable String field, @Nullable String oldValue, @Nullable String newValue, int version)

Method Detail

bibEntryIdback to summary
public @Nullable String bibEntryId()

Record Component getter of bibEntryId.

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).
fieldback to summary
public @Nullable String field()

Record Component getter of field.

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.

newValueback to summary
public @Nullable String newValue()

Record Component getter of newValue.

oldValueback to summary
public @Nullable String oldValue()

Record Component getter of oldValue.

sourceProcessorIdback to summary
public String sourceProcessorId()

Record Component getter of sourceProcessorId.

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.

versionback to summary
public int version()

Record Component getter of version.

Record Component
the entry's version after the change, as assigned by the database