Verified Owner
Top Description Fields Constructors Methods
org.jabref.model.undo

public final Record UndoableRemoveEntries

extends Record
implements BibChange
Class Inheritance
All Implemented Interfaces
org.jabref.model.undo.BibChange
Annotations
@NullMarked
Record Components
database:BibDatabase 
entries:List<BibEntry> 
reinsertSource:EntriesEventSource 
Imports
java.util.List, .Objects, org.jabref.model.database.BibDatabase, org.jabref.model.entry.BibEntry, org.jabref.model.entry.event.EntriesEventSource, org.jspecify.annotations.NullMarked

Removal of entries from the library. See UndoableInsertEntries on why the entry objects are retained rather than looked up again on undo.

reinsertSource is the event source the inverse change reports when it puts the entries back. It defaults to EntriesEventSource#UNDO, because restoring removed entries must not auto-assign them to the currently selected group. Removal itself is always reported as a local change.

Field Summary

Modifier and TypeField and Description
private final BibDatabase
database

Record Component accessed by database().

private final List<BibEntry>
entries

Record Component accessed by entries().

private final EntriesEventSource
reinsertSource

Record Component accessed by reinsertSource().

Constructor Summary

AccessConstructor and Description
public
public
public

Method Summary

Modifier and TypeMethod and Description
public ApplyResult
apply()

Implements org.jabref.model.undo.BibChange.apply.

Performs this change.

public BibDatabase
database()

Record Component getter of database.

public List<BibEntry>
entries()

Record Component getter of entries.

public boolean
equals(Object object)

Implements abstract java.lang.Record.equals.

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

public int
hashCode()

Implements abstract java.lang.Record.hashCode.

Returns a hash code value for the record.

public UndoableInsertEntries
inverted()

Implements org.jabref.model.undo.BibChange.inverted.

The change that reverses this one.

public EntriesEventSource
reinsertSource()

Record Component getter of reinsertSource.

public final String
toString()

Implements abstract java.lang.Record.toString.

Returns a string representation of the record.

Field Detail

databaseback to summary
private final BibDatabase database

Record Component accessed by database().

entriesback to summary
private final List<BibEntry> entries

Record Component accessed by entries().

reinsertSourceback to summary
private final EntriesEventSource reinsertSource

Record Component accessed by reinsertSource().

Constructor Detail

UndoableRemoveEntriesback to summary
public UndoableRemoveEntries(BibDatabase database, List<BibEntry> entries, EntriesEventSource reinsertSource)
UndoableRemoveEntriesback to summary
public UndoableRemoveEntries(BibDatabase database, List<BibEntry> entries)
UndoableRemoveEntriesback to summary
public UndoableRemoveEntries(BibDatabase database, BibEntry entry)

Method Detail

applyback to summary
public ApplyResult apply()

Implements org.jabref.model.undo.BibChange.apply.

Doc from org.jabref.model.undo.BibChange.apply.

Performs this change.

Implementations hold whatever they need to act on — an entry, a string, the database — so that recording a change never requires plumbing a context to the call site.

A change that describes one value refuses when the library no longer holds that value, because a command writing on a background thread can have moved it on since, and writing over it would produce a library no step on the stack describes. A change that describes a collection or a whole subtree applies unconditionally: comparing all of it on every apply costs more than the case is worth, and a partial comparison would only look like a check.

A change describing one modification performs it or throws, and so always returns ApplyResult#SUCCESS. Only ChangeSet can apply part of what it describes, and the return value is how it says so instead of reporting a success it did not deliver.

Annotations
@Override
databaseback to summary
public BibDatabase database()

Record Component getter of database.

entriesback to summary
public List<BibEntry> entries()

Record Component getter of entries.

equalsback to summary
public boolean equals(Object object)

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).
Annotations
@Override
hashCodeback to summary
public 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.

Annotations
@Override
invertedback to summary
public UndoableInsertEntries inverted()

Implements org.jabref.model.undo.BibChange.inverted.

Doc from org.jabref.model.undo.BibChange.inverted.

The change that reverses this one.

Must be an involution: change.inverted().inverted() equals change.

Annotations
@Override
reinsertSourceback to summary
public EntriesEventSource reinsertSource()

Record Component getter of reinsertSource.

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.