Modifier and Type	Class and Description
public static record	ParserResult.Range

Modifier and Type	Field and Description
private final Map<BibEntry, ParserResult.Range>	articleRanges
private boolean	changedOnMigration
private @NonNull BibDatabase	database
private final Set<BibEntryType>	entryTypes
private final Map<BibEntry, Map<Field, ParserResult.Range>>	fieldRanges
private @Nullable Path	file
private boolean	invalid
private MetaData	metaData
private final Multimap<ParserResult.Range, String>	warnings

Access	Constructor and Description
public	ParserResult()
public	ParserResult(Collection<BibEntry> entries)
public	ParserResult(BibDatabase database)
public	ParserResult(@NonNull BibDatabase database, @NonNull MetaData metaData, @NonNull Set<BibEntryType> entryTypes)

Method Summary

Modifier and Type	Method and Description
public void	addException(ParserResult.Range range, Exception exception)
public void	addWarning(@NonNull String String Warning text. Must be pre-translated. Only added if there isn't already a dupe. s) Add a parser warning.
public void	addWarning(ParserResult.Range range, @NonNull String s)
public static ParserResult	fromError(Exception exception)
public static ParserResult	fromErrorMessage(String message)
public Map<BibEntry, ParserResult.Range>	getArticleRanges()
public boolean	getChangedOnMigration()
public ParserResult.Range	getCompleteEntryIndicator(BibEntry entry) Returns a `Range` indicating that a complete entry is hit.
public @NonNull BibDatabase	getDatabase()
public BibDatabaseContext	getDatabaseContext()
public @NonNull Set<BibEntryType>	getEntryTypes()
private static String	getErrorMessage(Exception exception)
public String	getErrorMessage()
public ParserResult.Range	getFieldRange(BibEntry entry, Field field) Returns a `Range` indicating that a complete entry is hit.
public Map<BibEntry, Map<Field, ParserResult.Range>>	getFieldRanges()
public MetaData	getMetaData()
public Optional<Path>	getPath()
public Multimap<ParserResult.Range, String>	getWarningsMap()
public boolean	hasWarnings()
public boolean	isEmpty()
public boolean	isInvalid()
public void	setChangedOnMigration(boolean wasChangedOnMigration)
public void	setDatabaseContext(@NonNull BibDatabaseContext bibDatabaseContext)
public void	setInvalid(boolean invalid)
public void	setMetaData(MetaData md)
public void	setPath(@Nullable Path path)
public List<String>	warnings()

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

articleRanges	back to summary
private final Map<BibEntry, ParserResult.Range> articleRanges

changedOnMigration	back to summary
private boolean changedOnMigration

database	back to summary
private @NonNull BibDatabase database

entryTypes	back to summary
private final Set<BibEntryType> entryTypes

fieldRanges	back to summary
private final Map<BibEntry, Map<Field, ParserResult.Range>> fieldRanges

file	back to summary
private @Nullable Path file

invalid	back to summary
private boolean invalid

warnings	back to summary
private final Multimap<ParserResult.Range, String> warnings

Constructor Detail

ParserResult	back to summary
public ParserResult()

ParserResult	back to summary
public ParserResult(Collection<BibEntry> entries)

ParserResult	back to summary
public ParserResult(BibDatabase database)

ParserResult	back to summary
public ParserResult(@NonNull BibDatabase database, @NonNull MetaData metaData, @NonNull Set<BibEntryType> entryTypes)

Method Detail

addException	back to summary
public void addException(ParserResult.Range range, Exception exception)

addWarning	back to summary
public void addWarning(@NonNull String s) Add a parser warning. Parameters s:@NonNull String String Warning text. Must be pre-translated. Only added if there isn't already a dupe.

addWarning

back to summary

public void addWarning(@NonNull String s)

Add a parser warning.

Parameters

s:@NonNull String: String Warning text. Must be pre-translated. Only added if there isn't already a dupe.

addWarning	back to summary
public void addWarning(ParserResult.Range range, @NonNull String s)

fromError	back to summary
public static ParserResult fromError(Exception exception)

fromErrorMessage	back to summary
public static ParserResult fromErrorMessage(String message)

getArticleRanges	back to summary
public Map<BibEntry, ParserResult.Range> getArticleRanges()

getChangedOnMigration	back to summary
public boolean getChangedOnMigration()

getCompleteEntryIndicator	back to summary
public ParserResult.Range getCompleteEntryIndicator(BibEntry entry) Returns a `Range` indicating that a complete entry is hit. We use the line of the key. No key is found, the complete entry range is used.

getDatabase	back to summary
public @NonNull BibDatabase getDatabase()

getDatabaseContext	back to summary
public BibDatabaseContext getDatabaseContext()

getEntryTypes	back to summary
public @NonNull Set<BibEntryType> getEntryTypes()

getErrorMessage	back to summary
private static String getErrorMessage(Exception exception)

getErrorMessage	back to summary
public String getErrorMessage()

getFieldRange	back to summary
public ParserResult.Range getFieldRange(BibEntry entry, Field field) Returns a `Range` indicating that a complete entry is hit. We use the line of the key. No key is found, the complete entry range is used.

getFieldRanges	back to summary
public Map<BibEntry, Map<Field, ParserResult.Range>> getFieldRanges()

getMetaData	back to summary
public MetaData getMetaData()

getPath	back to summary
public Optional<Path> getPath()

getWarningsMap	back to summary
public Multimap<ParserResult.Range, String> getWarningsMap()

hasWarnings	back to summary
public boolean hasWarnings()

isEmpty	back to summary
public boolean isEmpty()

isInvalid	back to summary
public boolean isInvalid()

setChangedOnMigration	back to summary
public void setChangedOnMigration(boolean wasChangedOnMigration)

setDatabaseContext	back to summary
public void setDatabaseContext(@NonNull BibDatabaseContext bibDatabaseContext)

setInvalid	back to summary
public void setInvalid(boolean invalid)

setMetaData	back to summary
public void setMetaData(MetaData md)

setPath	back to summary
public void setPath(@Nullable Path path)

warnings	back to summary
public List<String> warnings()

org.jabref.logic.importer back to summary

public final Record ParserResult.Range

Class Inheritance

extends Record

java.lang.Object
java.lang.Record
org.jabref.logic.importer.ParserResult.Range

Record Components

startLine:int
startColumn:int
endLine:int
endColumn:int

Field Summary

Modifier and Type	Field and Description
private final int	endColumn Record Component accessed by endColumn().
private final int	endLine Record Component accessed by endLine().
public static final ParserResult.Range	NULL_RANGE
private final int	startColumn Record Component accessed by startColumn().
private final int	startLine Record Component accessed by startLine().

Constructor Summary

Access	Constructor and Description
public	Range(int startLine, int startColumn)
public	Range(int startLine, int startColumn, int endLine, int endColumn)

Method Summary

Modifier and Type	Method and Description
public int	endColumn() Record Component getter of endColumn.
public int	endLine() Record Component getter of endLine.
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public int	startColumn() Record Component getter of startColumn.
public int	startLine() Record Component getter of startLine.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

endColumn	back to summary
private final int endColumn Record Component accessed by endColumn().

endLine	back to summary
private final int endLine Record Component accessed by endLine().

NULL_RANGE	back to summary
public static final ParserResult.Range NULL_RANGE

startColumn	back to summary
private final int startColumn Record Component accessed by startColumn().

startLine	back to summary
private final int startLine Record Component accessed by startLine().

Constructor Detail

Range	back to summary
public Range(int startLine, int startColumn)

Range	back to summary
public Range(int startLine, int startColumn, int endLine, int endColumn)

Method Detail

endColumn	back to summary
public int endColumn() Record Component getter of endColumn.

endLine	back to summary
public int endLine() Record Component getter of endLine.

equals back to summary

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows:

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

hashCode back to summary

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

startColumn	back to summary
public int startColumn() Record Component getter of startColumn.

startLine	back to summary
public int startLine() Record Component getter of startLine.

toString back to summary

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

public Class ParserResult

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Record ParserResult.Range

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail