Top Fields Constructors Methods

org.jabref.toolkit.commands

pack-priv Class Check

Class Inheritance

extends Object
implements Callable<Integer>

java.lang.Object
org.jabref.toolkit.commands.Check

All Implemented Interfaces

java.util.concurrent.Callable

Annotations

@Command
name:check
description:Check the integrity and consistency of a library.
subcommands:CheckConsistency, CheckIntegrity

Imports

java.nio.file.Path, java.util.concurrent.Callable, org.jabref.logic.l10n.Localization, org.jabref.toolkit.converter.CygWinPathConverter, org.jabref.toolkit.exception.ImportServiceException

Field Summary

Modifier and Type	Field and Description
pack-priv static final String	FORMAT_CSV Output formats accepted by `--output-format`.
pack-priv static final String	FORMAT_ERRORFORMAT
pack-priv static final String	FORMAT_GITHUB_ACTIONS
pack-priv static final String	FORMAT_TXT
private Path	inputFile Optional positional input file.
protected JabKit	jabKit
private String	outputFormat
private JabKit.SharedOptions	sharedOptions

Constructor Summary

Access	Constructor and Description
pack-priv	Check()

Method Summary

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.
private int	checkConsistency()
private int	checkIntegrity()

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

Field Detail

FORMAT_CSV	back to summary
pack-priv static final String FORMAT_CSV Output formats accepted by `--output-format`. Kept lowercase so they can also serve as `case` labels for a switch over `outputFormat.toLowerCase(...)`.

FORMAT_ERRORFORMAT	back to summary
pack-priv static final String FORMAT_ERRORFORMAT

FORMAT_GITHUB_ACTIONS	back to summary
pack-priv static final String FORMAT_GITHUB_ACTIONS

FORMAT_TXT	back to summary
pack-priv static final String FORMAT_TXT

inputFile	back to summary
private Path inputFile Optional positional input file. When supplied directly to `check` (without a `consistency` or `integrity` subcommand), both checks run against it. Annotations @Parameters index:0 arity:0..1 paramLabel:FILE converter:CygWinPathConverter description:Input file. When given without a subcommand, both the consistency and integrity checks run.

jabKit	back to summary
protected JabKit jabKit Annotations @ParentCommand

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

Constructor Detail

Check	back to summary
pack-priv Check()

Method Detail

call

back to summary

public Integer call()

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

checkConsistency	back to summary
private int checkConsistency()

checkIntegrity	back to summary
private int checkIntegrity()