Verified Owner
Top Inners Fields Constructors Methods
org.jabref.toolkit.commands

public Class JabKit

extends Object
implements Runnable
Class Inheritance
All Implemented Interfaces
java.lang.Runnable
Annotations
@Command
name:jabkit
mixinStandardHelpOptions:true
subcommands:Check, CitationKeys, Convert, DoiToBibtex, Fetch, GenerateBibFromAux, GetCitedWorks, GetCitingWorks, Pdf, Preferences, Pseudonymize, Search
Imports
org.jabref.logic.preferences.CliPreferences, org.jabref.logic.util.BuildInfo, org.jabref.model.entry.BibEntryTypesManager, picocli.CommandLine

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
JabKit.SharedOptions

Field Summary

Modifier and TypeField and Description
protected final CliPreferences
cliPreferences

protected final BibEntryTypesManager
entryTypesManager

private JabKit.SharedOptions
sharedOptions

Left uninitialized so picocli's factory supplies the same shared instance used by every (sub)command in the tree; see JabKitLauncher.

private boolean
versionInfoRequested

Constructor Summary

AccessConstructor and Description
public
JabKit(CliPreferences cliPreferences, BibEntryTypesManager entryTypesManager)

Method Summary

Modifier and TypeMethod and Description
public static CommandLine.IFactory
createFactory()

Every (sub)command mixes in SharedOptions to allow -p/-d/-h at any command depth (e.g. both jabkit -p check consistency and jabkit check consistency -p).

public void
run()

Implements java.lang.Runnable.run.

Runs this operation.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

cliPreferencesback to summary
protected final CliPreferences cliPreferences
entryTypesManagerback to summary
protected final BibEntryTypesManager entryTypesManager
sharedOptionsback to summary
private JabKit.SharedOptions sharedOptions

Left uninitialized so picocli's factory supplies the same shared instance used by every (sub)command in the tree; see JabKitLauncher.

Annotations
@Mixin
versionInfoRequestedback to summary
private boolean versionInfoRequested
Annotations
@Option
names:-v, --version
versionHelp:true
description:display version info

Constructor Detail

JabKitback to summary
public JabKit(CliPreferences cliPreferences, BibEntryTypesManager entryTypesManager)

Method Detail

createFactoryback to summary
public static CommandLine.IFactory createFactory()

Every (sub)command mixes in SharedOptions to allow -p/-d/-h at any command depth (e.g. both jabkit -p check consistency and jabkit check consistency -p). picocli resolves each mixin site independently, so without this factory each site would get its own, disconnected SharedOptions instance. Use the returned factory for every CommandLine built over a JabKit command tree, so all sites share one instance instead.

runback to summary
public void run()

Implements java.lang.Runnable.run.

Doc from java.lang.Runnable.run.

Runs this operation.

Annotations
@Override
org.jabref.toolkit.commands back to summary

public Class JabKit.SharedOptions

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
pack-priv boolean
debug

pack-priv boolean
porcelain

private boolean
usageHelpRequested

Constructor Summary

AccessConstructor and Description
public
SharedOptions()

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

debugback to summary
pack-priv boolean debug
Annotations
@Option
names:-d, --debug
description:Enable debug output
porcelainback to summary
pack-priv boolean porcelain
Annotations
@Option
names:-p, --porcelain
description:Enable script-friendly output
usageHelpRequestedback to summary
private boolean usageHelpRequested
Annotations
@Option
names:-h, --help
usageHelp:true
description:Display this help message

Constructor Detail

SharedOptionsback to summary
public SharedOptions()