Refactor EntryEvents - removal part #5410
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| package org.jabref.gui.undo; | ||
|
|
||
| import java.util.Collections; | ||
| import java.util.List; | ||
|
|
||
| import org.jabref.logic.l10n.Localization; | ||
| import org.jabref.model.database.BibDatabase; | ||
| import org.jabref.model.entry.BibEntry; | ||
| import org.jabref.model.entry.event.EntriesEventSource; | ||
| import org.jabref.model.strings.StringUtil; | ||
|
|
||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| /** | ||
| * This class represents the removal of entries. The constructor needs | ||
| * references to the database, the entries, and the map of open entry editors. | ||
| * TODO is this map still being used? | ||
|
There was a problem hiding this comment. It would appear the map is not being used, as there is no reference to entry editors in the class. Am I mistaken? |
||
| * The latter to be able to close the entry's editor if it is opened after | ||
| * an undo, and the removal is then undone. | ||
| */ | ||
| public class UndoableRemoveEntries extends AbstractUndoableJabRefEdit { | ||
|
|
||
| private static final Logger LOGGER = LoggerFactory.getLogger(UndoableRemoveEntries.class); | ||
| private final BibDatabase base; | ||
| private final List<BibEntry> entries; | ||
| private final boolean cut; | ||
|
|
||
| public UndoableRemoveEntries(BibDatabase base, BibEntry entry) { | ||
| this(base, Collections.singletonList(entry)); | ||
| } | ||
|
|
||
| public UndoableRemoveEntries(BibDatabase base, List<BibEntry> entries) { | ||
| this(base, entries, false); | ||
| } | ||
|
|
||
| public UndoableRemoveEntries(BibDatabase base, List<BibEntry> entries, boolean cut) { | ||
| this.base = base; | ||
| this.entries = entries; | ||
| this.cut = cut; | ||
| } | ||
|
|
||
| @Override | ||
| public String getPresentationName() { | ||
| if (cut) { | ||
| if (entries.size() > 1) { | ||
| return Localization.lang("cut entries"); | ||
| } | ||
| else if (entries.size() == 1) { | ||
| return Localization.lang("cut entry %0", | ||
| StringUtil.boldHTML(entries.get(0).getCiteKeyOptional().orElse(Localization.lang("undefined")))); | ||
| } else { | ||
| return null; | ||
|
There was a problem hiding this comment. Should there something be logged? There was a problem hiding this comment. I hadn't thought of that. What do you think? |
||
| } | ||
| } else { | ||
| if (entries.size() > 1) { | ||
| return Localization.lang("remove entries"); | ||
| } | ||
| else if (entries.size() == 1) { | ||
|
There was a problem hiding this comment. Please format the code using JabRef's code style --> The There was a problem hiding this comment. Got it. Let me know if I've fixed it right. Is there a way to get IntelliJ to do this automatically? |
||
| return Localization.lang("remove entry %0", | ||
| StringUtil.boldHTML(entries.get(0).getCiteKeyOptional().orElse(Localization.lang("undefined")))); | ||
| } | ||
| else { | ||
| return null; | ||
|
There was a problem hiding this comment. Should there something be logged? There was a problem hiding this comment. I hadn't thought of that. What do you think? |
||
| } | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public void undo() { | ||
| super.undo(); | ||
| base.insertEntries(entries, EntriesEventSource.UNDO); | ||
| } | ||
|
|
||
| @Override | ||
| public void redo() { | ||
| super.redo(); | ||
|
|
||
| // Redo the change. | ||
| try { | ||
| base.removeEntries(entries); | ||
| } catch (Throwable ex) { | ||
| LOGGER.warn("Problem to redo `remove entries`", ex); | ||
| } | ||
| } | ||
|
|
||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I use the constructor of
UndoableRemoveEntriesaccepting a single BibEntry, and similarly the methodBibDatabase#removeEntry.(Btw, there is
Colections.singletonList(element)which is preferred overnew ArrayList<>(element)).There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The problem is that
DuplicateSearch.getToRemovereturns a Collection, not a single one. The only way I found that I could coerce aCollectionto aListwas via theArrayList<>constructor. I could make a constructor for aCollection, but that feels to specific.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+1 for the second constructor. Even if very specific, the code with
new ArrayList<>reads strange.