Verified Owner
Top Description Methods
org.jabref.logic.push

public Interface PushToApplication

Known Direct Implementers
org.jabref.logic.push.AbstractPushToApplication
Imports
java.nio.file.Path, java.util.List, org.jabref.model.entry.BibEntry
Class that defines interaction with an external application in the form of "pushing" selected entries to it.

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

The delimiter as a String.
getDelimiter()

Get the delimiter used to separate citation keys.

public String

Returns:

The display name for the push operation.
getDisplayName()

Gets the display name for the push operation.

public void
jumpToLine(Path fileName, int line, int column)

public void
onOperationCompleted()

Reporting etc., this method is called on the event dispatch thread after pushEntries() returns.

public void
pushEntries(List<BibEntry> entries)

The actual operation.

public boolean

Returns:

true if citation keys are required for this operation.
requiresCitationKeys()

Check whether this operation requires citation keys to be set for the entries.

public void
sendErrorNotification(String title, String message)

Used to route to either the GUI or the CLI - dependent on the usage

public void
sendErrorNotification(String message)

Used to route to either the GUI or the CLI - dependent on the usage

Method Detail

getDelimiterback to summary
public String getDelimiter()

Get the delimiter used to separate citation keys.

Returns:String

The delimiter as a String.

getDisplayNameback to summary
public String getDisplayName()

Gets the display name for the push operation. This name is used in the GUI to represent the push action to the user.

Returns:String

The display name for the push operation.

jumpToLineback to summary
public void jumpToLine(Path fileName, int line, int column)
onOperationCompletedback to summary
public void onOperationCompleted()

Reporting etc., this method is called on the event dispatch thread after pushEntries() returns.

pushEntriesback to summary
public void pushEntries(List<BibEntry> entries)

The actual operation. This method will not be called on the event dispatch thread, so it should not do GUI operations without utilizing invokeLater().

requiresCitationKeysback to summary
public boolean requiresCitationKeys()

Check whether this operation requires citation keys to be set for the entries. If true is returned an error message will be displayed if keys are missing.

Returns:boolean

true if citation keys are required for this operation.

sendErrorNotificationback to summary
public void sendErrorNotification(String title, String message)

Used to route to either the GUI or the CLI - dependent on the usage

sendErrorNotificationback to summary
public void sendErrorNotification(String message)

Used to route to either the GUI or the CLI - dependent on the usage