JabRef 6.0-beta.1 · org.jabref.toolkit.commands.CheckConsistency

Field Summary

Modifier and Type	Field and Description
private Check	check
private InputOption	inputOption
private static final Logger	LOGGER
private String	outputFormat
private JabKit.SharedOptions	sharedOptions

Access	Constructor and Description
pack-priv	CheckConsistency()

Modifier and Type	Method and Description
public Integer	call() Implements java.util.concurrent.Callable.call. Computes a result, or throws an exception if unable to do so.
pack-priv static int	Returns: the exit code (0 = consistent, 1 = inconsistencies found, 2/3 = error) execute(Path inputFile, String outputFormat, boolean porcelain, JabKit jabKit) Runs the consistency check on `inputFile` and writes the findings to `System.out`.
private static int	writeCheckResult(Result result, BibDatabaseContext databaseContext, ParserResult parserResult, Path inputFile, String outputFormat, boolean porcelain, JabKit jabKit)

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

check	back to summary
private Check check Annotations @ParentCommand

inputOption	back to summary
private InputOption inputOption Annotations @Mixin

LOGGER	back to summary
private static final Logger LOGGER

outputFormat	back to summary
private String outputFormat Annotations @Option names:--output-format description:Output format: csv, errorformat, github-actions or txt defaultValue:errorformat

sharedOptions	back to summary
private JabKit.SharedOptions sharedOptions Annotations @Mixin

CheckConsistency	back to summary
pack-priv CheckConsistency()

call	back to summary
public Integer call() throws ImportServiceException Implements java.util.concurrent.Callable.call. Doc from java.util.concurrent.Callable.call. Computes a result, or throws an exception if unable to do so. Annotations @Override

call

public Integer call() throws ImportServiceException

Computes a result, or throws an exception if unable to do so.

Annotations

execute back to summary

execute	back to summary
pack-priv static int execute(Path inputFile, String outputFormat, boolean porcelain, JabKit jabKit) throws ImportServiceException Runs the consistency check on `inputFile` and writes the findings to `System.out`. Shared with the parent `check` command, which runs both checks at once. Returns:int the exit code (0 = consistent, 1 = inconsistencies found, 2/3 = error)

pack-priv static int execute(Path inputFile, String outputFormat, boolean porcelain, JabKit jabKit) throws ImportServiceException

Runs the consistency check on inputFile and writes the findings to System.out.

Shared with the parent check command, which runs both checks at once.

Returns:int: the exit code (0 = consistent, 1 = inconsistencies found, 2/3 = error)

writeCheckResult	back to summary
private static int writeCheckResult(Result result, BibDatabaseContext databaseContext, ParserResult parserResult, Path inputFile, String outputFormat, boolean porcelain, JabKit jabKit)