Reusable input-file argument shared by all jabkit subcommands that read a single file.

The file can be supplied either as a positional argument (jabkit check integrity references.bib) or via the --input option (jabkit check integrity --input references.bib). The positional form is the preferred, idiomatic style; --input is retained as a backward-compatible alias.

Exactly one of the two forms must be given; picocli enforces this at parse time via the required, mutually exclusive ArgGroup.

Both forms also accept an http://, https://, or ftp:// URL, which is downloaded to a local temporary file before being used as the input, and a PostgreSQL connection URL such as postgresql://user:secret@host:5432/library, whose shared library is exported to a temporary .bib file before being used as the input (read-only).

See ADR-0057 (which supersedes ADR-0045) and ADR-0065 for the rationale.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	InputOption.InputSource `--input` is a backward-compatible alias here; the positional form and the alias both come from ADR 57, which superseded the `--input`-only ADR 45.

Modifier and Type	Field and Description
private InputOption.InputSource	inputSource
private static final Logger	LOGGER

Access	Constructor and Description
pack-priv	InputOption()

Method Summary

Modifier and Type	Method and Description
pack-priv Path	getInputFile(CliPreferences preferences) Returns: the resolved input file, downloading it to a temporary file first if a URL was supplied
private static boolean	isPostgreSqlUrl(String input) `DBMSConnectionUrl#parse` is deliberately permissive: it finds a PostgreSQL URL anywhere in a pasted text and also accepts libpq's `host=...`
private static Path	pullSharedDatabase(DBMSConnectionUrl connectionUrl, CliPreferences preferences)
pack-priv static Path	Returns: the resolved input file, downloading it to a temporary file first if a URL was supplied resolveInput(String input, CliPreferences preferences) Resolves a single input argument to a local file: a URL is downloaded to a temporary file, anything else is taken as a (possibly Cygwin-style) local path.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

inputSource	back to summary
private InputOption.InputSource inputSource Annotations @ArgGroup exclusive:true multiplicity:1

LOGGER	back to summary
private static final Logger LOGGER

InputOption	back to summary
pack-priv InputOption()

Method Detail

getInputFile	back to summary
pack-priv Path getInputFile(CliPreferences preferences) throws ImportServiceException Returns:Path the resolved input file, downloading it to a temporary file first if a URL was supplied Exceptions ImportServiceException: if a URL was supplied and could not be downloaded

isPostgreSqlUrl back to summary

isPostgreSqlUrl	back to summary
private static boolean isPostgreSqlUrl(String input) `DBMSConnectionUrl#parse` is deliberately permissive: it finds a PostgreSQL URL anywhere in a pasted text and also accepts libpq's `host=... dbname=...` keyword form, which the GUI needs. On the command line that would swallow local files whose name happens to contain such a fragment, so only an argument that starts with the scheme is offered to it.

private static boolean isPostgreSqlUrl(String input)

DBMSConnectionUrl#parse is deliberately permissive: it finds a PostgreSQL URL anywhere in a pasted text and also accepts libpq's host=... dbname=... keyword form, which the GUI needs. On the command line that would swallow local files whose name happens to contain such a fragment, so only an argument that starts with the scheme is offered to it.

pullSharedDatabase	back to summary
private static Path pullSharedDatabase(DBMSConnectionUrl connectionUrl, CliPreferences preferences) throws ImportServiceException

resolveInput back to summary

resolveInput	back to summary
pack-priv static Path resolveInput(String input, CliPreferences preferences) throws ImportServiceException Resolves a single input argument to a local file: a URL is downloaded to a temporary file, anything else is taken as a (possibly Cygwin-style) local path. Commands reading more than one input cannot use this mixin — its `ArgGroup` binds a single argument — and call this method per input instead. Returns:Path the resolved input file, downloading it to a temporary file first if a URL was supplied Exceptions ImportServiceException: if a URL was supplied and could not be downloaded

pack-priv static Path resolveInput(String input, CliPreferences preferences) throws ImportServiceException

Resolves a single input argument to a local file: a URL is downloaded to a temporary file, anything else is taken as a (possibly Cygwin-style) local path.

Commands reading more than one input cannot use this mixin — its ArgGroup binds a single argument — and call this method per input instead.

Returns:Path

the resolved input file, downloading it to a temporary file first if a URL was supplied

Exceptions

ImportServiceException:: if a URL was supplied and could not be downloaded

org.jabref.toolkit.commands back to summary

private Class InputOption.InputSource

Class Inheritance

extends Object

java.lang.Object
org.jabref.toolkit.commands.InputOption.InputSource

--input is a backward-compatible alias here; the positional form and the alias both come from ADR 57, which superseded the --input-only ADR 45.

Field Summary

Modifier and Type	Field and Description
private String	optionInput
private String	positionalInput

Constructor Summary

Access	Constructor and Description
private	InputSource()

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

optionInput	back to summary
private String optionInput Annotations @Option names:--input description:Input file, an http(s)/ftp URL, or a PostgreSQL connection URL (alias for the positional FILE argument).

positionalInput	back to summary
private String positionalInput Annotations @Parameters index:0 paramLabel:FILE description:Input file, an http(s)/ftp URL, or a PostgreSQL connection URL. Alternatively, pass it via --input.

Constructor Detail

InputSource	back to summary
private InputSource()

pack-priv Class InputOption

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class InputOption.InputSource

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail