JabRef 5.15 · org.jabref.logic.bst.BstVMContext · APIdia, the JavaDoc alternative

Field Summary

Modifier and Type	Field and Description
private final BibDatabase	bibDatabase Record Component accessed by bibDatabase().
private final List<BstEntry>	entries Record Component accessed by entries().
private final Map<String, BstFunctions.BstFunction>	functions Record Component accessed by functions().
private final Map<String, Integer>	integers Record Component accessed by integers().
private final Optional<Path>	path Record Component accessed by path().
private final Deque<Object>	stack Record Component accessed by stack().
private final Map<String, String>	strings Record Component accessed by strings().

Constructor Summary

Access	Constructor and Description
public	BstVMContext(List<BstEntry> entries, BibDatabase bibDatabase, Path path)
public	BstVMContext(List<BstEntry> entries, Map<String, String> strings, Map<String, Integer> integers, Map<String, BstFunctions.BstFunction> functions, Deque<Object> stack, BibDatabase bibDatabase, Optional<Path> path)

Method Summary

Modifier and Type	Method and Description
public BibDatabase	bibDatabase() Record Component getter of bibDatabase.
public List<BstEntry>	entries() Record Component getter of entries.
public final boolean	equals(Object the reference object with which to compare. o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public Map<String, BstFunctions.BstFunction>	functions() Record Component getter of functions.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public Map<String, Integer>	integers() Record Component getter of integers.
public Optional<Path>	path() Record Component getter of path.
public Deque<Object>	stack() Record Component getter of stack.
public Map<String, String>	strings() Record Component getter of strings.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

bibDatabase	back to summary
private final BibDatabase bibDatabase Record Component accessed by bibDatabase().

entries	back to summary
private final List<BstEntry> entries Record Component accessed by entries().

functions	back to summary
private final Map<String, BstFunctions.BstFunction> functions Record Component accessed by functions().

integers	back to summary
private final Map<String, Integer> integers Record Component accessed by integers().

path	back to summary
private final Optional<Path> path Record Component accessed by path().

stack	back to summary
private final Deque<Object> stack Record Component accessed by stack().

strings	back to summary
private final Map<String, String> strings Record Component accessed by strings().

Constructor Detail

BstVMContext	back to summary
public BstVMContext(List<BstEntry> entries, BibDatabase bibDatabase, Path path)

BstVMContext	back to summary
public BstVMContext(List<BstEntry> entries, Map<String, String> strings, Map<String, Integer> integers, Map<String, BstFunctions.BstFunction> functions, Deque<Object> stack, BibDatabase bibDatabase, Optional<Path> path)

Method Detail

bibDatabase	back to summary
public BibDatabase bibDatabase() Record Component getter of bibDatabase.

entries	back to summary
public List<BstEntry> entries() Record Component getter of entries.

equals back to summary

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)`. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this record is equal to the argument; `false` otherwise.

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

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this record is equal to the argument; false otherwise.

functions	back to summary
public Map<String, BstFunctions.BstFunction> functions() Record Component getter of functions.

hashCode back to summary

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. Returns:int a hash code value for this record.

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.

Returns:int: a hash code value for this record.

integers	back to summary
public Map<String, Integer> integers() Record Component getter of integers.

path	back to summary
public Optional<Path> path() Record Component getter of path.

stack	back to summary
public Deque<Object> stack() Record Component getter of stack.

strings	back to summary
public Map<String, String> strings() Record Component getter of strings.

toString back to summary

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. Returns:String a string representation of the object.

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.