JabRef 6.0-beta.1 · org.jabref.model.undo.UndoableInsertEntries

Modifier and Type	Field and Description
private final BibDatabase	database Record Component accessed by database().
private final List<BibEntry>	entries Record Component accessed by entries().
private final EntriesEventSource	source Record Component accessed by source().

Access	Constructor and Description
public	UndoableInsertEntries(BibDatabase database, List<BibEntry> entries, EntriesEventSource source)
public	UndoableInsertEntries(BibDatabase database, List<BibEntry> entries)
public	UndoableInsertEntries(BibDatabase database, BibEntry entry)

Method Summary

Modifier and Type	Method 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 UndoableRemoveEntries	inverted() Implements org.jabref.model.undo.BibChange.inverted. The change that reverses this one.
public EntriesEventSource	source() Record Component getter of source.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

database	back to summary
private final BibDatabase database Record Component accessed by database().

entries	back to summary
private final List<BibEntry> entries Record Component accessed by entries().

source	back to summary
private final EntriesEventSource source Record Component accessed by source().

UndoableInsertEntries	back to summary
public UndoableInsertEntries(BibDatabase database, List<BibEntry> entries, EntriesEventSource source)

UndoableInsertEntries	back to summary
public UndoableInsertEntries(BibDatabase database, List<BibEntry> entries)

UndoableInsertEntries	back to summary
public UndoableInsertEntries(BibDatabase database, BibEntry entry)

Method Detail

apply back to summary

apply	back 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

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

database	back to summary
public BibDatabase database() Record Component getter of database.

entries	back to summary
public List<BibEntry> entries() Record Component getter of entries.

equals back to summary

equals	back 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

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

hashCode back to summary

hashCode	back 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

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

inverted back to summary

inverted	back to summary
public UndoableRemoveEntries 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

public UndoableRemoveEntries 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

source	back to summary
public EntriesEventSource source() Record Component getter of source.

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.

public final Record UndoableInsertEntries

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail