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

Modifier and Type	Field and Description
private final EntryType	after Record Component accessed by after().
private final EntryType	before Record Component accessed by before().
private final BibEntry	entry Record Component accessed by entry().

Access	Constructor and Description
public	UndoableChangeType(BibEntry entry, EntryType before, EntryType after)

Method Summary

Modifier and Type	Method and Description
public EntryType	after() Record Component getter of after.
public ApplyResult	apply() Implements org.jabref.model.undo.BibChange.apply. Performs this change.
public EntryType	before() Record Component getter of before.
public BibEntry	entry() Record Component getter of entry.
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 UndoableChangeType	inverted() Implements org.jabref.model.undo.BibChange.inverted. The change that reverses this one.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

after	back to summary
private final EntryType after Record Component accessed by after().

before	back to summary
private final EntryType before Record Component accessed by before().

entry	back to summary
private final BibEntry entry Record Component accessed by entry().

UndoableChangeType	back to summary
public UndoableChangeType(BibEntry entry, EntryType before, EntryType after)

Method Detail

after	back to summary
public EntryType after() Record Component getter of after.

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

before	back to summary
public EntryType before() Record Component getter of before.

entry	back to summary
public BibEntry entry() Record Component getter of entry.

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 UndoableChangeType 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 UndoableChangeType 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

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 UndoableChangeType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail