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

public final Record UndoStep

extends Record
Class Inheritance
Annotations
@NullMarked
Record Components
name:String
the step, named as the user would recognise it — see BibChangeDescriber
complete:boolean
whether every change in the step could be applied
Imports
org.jspecify.annotations.NullMarked
What an undo or a redo did: which step it moved, and whether all of it went through.

Field Summary

Modifier and TypeField and Description
private final boolean
complete

Record Component accessed by complete().

whether every change in the step could be applied
private final String
name

Record Component accessed by name().

the step, named as the user would recognise it — see BibChangeDescriber

Constructor Summary

AccessConstructor and Description
public
UndoStep(String name, boolean complete)

Method Summary

Modifier and TypeMethod and Description
public boolean
complete()

Record Component getter of complete.

Record Component whether every change in the step could be applied

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

Record Component getter of name.

Record Component the step, named as the user would recognise it — see BibChangeDescriber

public final String
toString()

Implements abstract java.lang.Record.toString.

Returns a string representation of the record.

Field Detail

completeback to summary
private final boolean complete

Record Component accessed by complete().

whether every change in the step could be applied

nameback to summary
private final String name

Record Component accessed by name().

the step, named as the user would recognise it — see BibChangeDescriber

Constructor Detail

UndoStepback to summary
public UndoStep(String name, boolean complete)

Method Detail

completeback to summary
public boolean complete()

Record Component getter of complete.

Record Component
whether every change in the step could be applied
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.

nameback to summary
public String name()

Record Component getter of name.

Record Component
the step, named as the user would recognise it — see BibChangeDescriber
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.