Verified Owner
Top Inners Fields Constructors Methods
org.jabref.languageserver.util.definition

public abstract Class DefinitionProvider

extends Object
Class Inheritance
Known Direct Subclasses
org.jabref.languageserver.util.definition.LatexDefinitionProvider, org.jabref.languageserver.util.definition.MarkdownDefinitionProvider, org.jabref.languageserver.util.definition.BibDefinitionProvider
Imports
java.util.ArrayList, .List, .Map, .Optional, java.util.regex.Matcher, .Pattern, org.jabref.languageserver.util.LspParserHandler, .LspRangeUtil, org.jabref.logic.importer.ParserResult, org.jabref.model.entry.BibEntry, com.google.gson.JsonArray, org.eclipse.lsp4j.DocumentLink, .Location, .Position, .Range

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static record
DefinitionProvider.KeyBounds

Field Summary

Modifier and TypeField and Description
protected Pattern
citationCommandPattern

protected Pattern
citationKeyInsidePattern

protected final LspParserHandler
parserHandler

Constructor Summary

AccessConstructor and Description
public
DefinitionProvider(LspParserHandler parserHandler)

Method Summary

Modifier and TypeMethod and Description
protected Location
createLocation(Range range, String uri)

private List<DefinitionProvider.KeyBounds>
findCitationKeys(String content)

pack-priv Optional<String>
getCitationKeyAtPosition(String content, Position position)

pack-priv Range
getRangeFromEntry(String fileUri, BibEntry entry)

public List<Location>
provideDefinition(String uri, String content, Position position)

protected static Optional<String>
safeGroup(Matcher matcher, String group)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

citationCommandPatternback to summary
protected Pattern citationCommandPattern
citationKeyInsidePatternback to summary
protected Pattern citationKeyInsidePattern
parserHandlerback to summary
protected final LspParserHandler parserHandler

Constructor Detail

DefinitionProviderback to summary
public DefinitionProvider(LspParserHandler parserHandler)

Method Detail

createDocumentLinkback to summary
protected DocumentLink createDocumentLink(Range range, String key)
createLocationback to summary
protected Location createLocation(Range range, String uri)
findCitationKeysback to summary
private List<DefinitionProvider.KeyBounds> findCitationKeys(String content)
getCitationKeyAtPositionback to summary
pack-priv Optional<String> getCitationKeyAtPosition(String content, Position position)
getRangeFromEntryback to summary
pack-priv Range getRangeFromEntry(String fileUri, BibEntry entry)
provideDefinitionback to summary
public List<Location> provideDefinition(String uri, String content, Position position)
provideDocumentLinksback to summary
public List<DocumentLink> provideDocumentLinks(String fileUri, String content)
safeGroupback to summary
protected static Optional<String> safeGroup(Matcher matcher, String group)
org.jabref.languageserver.util.definition back to summary

private final Record DefinitionProvider.KeyBounds

extends Record
Class Inheritance
Record Components
key:String 
start:int 
end:int 

Field Summary

Modifier and TypeField and Description
private final int
end

Record Component accessed by end().

private final String
key

Record Component accessed by key().

private final int
start

Record Component accessed by start().

Constructor Summary

AccessConstructor and Description
private
KeyBounds(String key, int start, int end)

Method Summary

Modifier and TypeMethod and Description
public int
end()

Record Component getter of end.

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 String
key()

Record Component getter of key.

public int
start()

Record Component getter of start.

public final String
toString()

Implements abstract java.lang.Record.toString.

Returns a string representation of the record.

Field Detail

endback to summary
private final int end

Record Component accessed by end().

keyback to summary
private final String key

Record Component accessed by key().

startback to summary
private final int start

Record Component accessed by start().

Constructor Detail

KeyBoundsback to summary
private KeyBounds(String key, int start, int end)

Method Detail

endback to summary
public int end()

Record Component getter of end.

equalsback 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).
hashCodeback 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.

keyback to summary
public String key()

Record Component getter of key.

startback to summary
public int start()

Record Component getter of start.

toStringback 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.