Verified Owner
Top Description Fields Constructors Methods
org.jabref.model.database

public final Record FileDirectories

extends Record
Class Inheritance
Annotations
@NullMarked
Record Components
userDirectory:@Nullable Path 
libraryDirectory:@Nullable Path 
fallbackDirectory:@Nullable Path 
Imports
java.nio.file.Path, java.util.Optional, org.jspecify.annotations.NullMarked, .Nullable
Holds the configured file directories in a fixed order.

Field Summary

Modifier and TypeField and Description
private final @Nullable Path
fallbackDirectory

Record Component accessed by fallbackDirectory().

private final @Nullable Path
libraryDirectory

Record Component accessed by libraryDirectory().

private final @Nullable Path
userDirectory

Record Component accessed by userDirectory().

Constructor Summary

AccessConstructor and Description
public
FileDirectories(@Nullable Path userDirectory, @Nullable Path libraryDirectory, @Nullable Path fallbackDirectory)

Method Summary

Modifier and TypeMethod and Description
public final boolean
equals(Object o)

Implements abstract java.lang.Record.equals.

Indicates whether some other object is "equal to" this one.

public @Nullable Path
fallbackDirectory()

Record Component getter of fallbackDirectory.

public Optional<Path>
getFallbackDirectoryOpt()

public Optional<Path>
getLibraryDirectoryOpt()

public Optional<Path>
getUserDirectoryOpt()

public final int
hashCode()

Implements abstract java.lang.Record.hashCode.

Returns a hash code value for the record.

public @Nullable Path
libraryDirectory()

Record Component getter of libraryDirectory.

public final String
toString()

Implements abstract java.lang.Record.toString.

Returns a string representation of the record.

public @Nullable Path
userDirectory()

Record Component getter of userDirectory.

Field Detail

fallbackDirectoryback to summary
private final @Nullable Path fallbackDirectory

Record Component accessed by fallbackDirectory().

libraryDirectoryback to summary
private final @Nullable Path libraryDirectory

Record Component accessed by libraryDirectory().

userDirectoryback to summary
private final @Nullable Path userDirectory

Record Component accessed by userDirectory().

Constructor Detail

FileDirectoriesback to summary
public FileDirectories(@Nullable Path userDirectory, @Nullable Path libraryDirectory, @Nullable Path fallbackDirectory)

Method Detail

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).
fallbackDirectoryback to summary
public @Nullable Path fallbackDirectory()

Record Component getter of fallbackDirectory.

getFallbackDirectoryOptback to summary
public Optional<Path> getFallbackDirectoryOpt()
getLibraryDirectoryOptback to summary
public Optional<Path> getLibraryDirectoryOpt()
getUserDirectoryOptback to summary
public Optional<Path> getUserDirectoryOpt()
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.

libraryDirectoryback to summary
public @Nullable Path libraryDirectory()

Record Component getter of libraryDirectory.

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.

userDirectoryback to summary
public @Nullable Path userDirectory()

Record Component getter of userDirectory.