Verified Owner
Top Fields Constructors Methods
org.jabref.model.ai.chatting

public final Record ChatIdentifier

extends Record
Class Inheritance
Record Components
libraryId:String 
chatType:ChatType 
chatName:String 
Imports
java.util.Optional, org.jabref.model.database.BibDatabaseContext, org.jabref.model.entry.BibEntry, org.jabref.model.groups.GroupTreeNode

Field Summary

Modifier and TypeField and Description
private final String
chatName

Record Component accessed by chatName().

private final ChatType
chatType

Record Component accessed by chatType().

private final String
libraryId

Record Component accessed by libraryId().

Constructor Summary

AccessConstructor and Description
public
ChatIdentifier(String libraryId, ChatType chatType, String chatName)

Method Summary

Modifier and TypeMethod and Description
public String
chatName()

Record Component getter of chatName.

public ChatType
chatType()

Record Component getter of chatType.

public final boolean
equals(Object o)

Implements abstract java.lang.Record.equals.

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

public static Optional<ChatIdentifier>

Returns:

Optional#empty() if the preconditions are not met
from
(BibDatabaseContext ctx, BibEntry entry)

Creates a ChatIdentifier for an entry if it has a valid AI library ID and a present, unique citation key.

public static Optional<ChatIdentifier>

Returns:

Optional#empty() if the preconditions are not met
from
(BibDatabaseContext ctx, GroupTreeNode group)

Creates a ChatIdentifier for a group if it has a valid AI library ID.

public final int
hashCode()

Implements abstract java.lang.Record.hashCode.

Returns a hash code value for the record.

public String
libraryId()

Record Component getter of libraryId.

public final String
toString()

Implements abstract java.lang.Record.toString.

Returns a string representation of the record.

Field Detail

chatNameback to summary
private final String chatName

Record Component accessed by chatName().

chatTypeback to summary
private final ChatType chatType

Record Component accessed by chatType().

libraryIdback to summary
private final String libraryId

Record Component accessed by libraryId().

Constructor Detail

ChatIdentifierback to summary
public ChatIdentifier(String libraryId, ChatType chatType, String chatName)

Method Detail

chatNameback to summary
public String chatName()

Record Component getter of chatName.

chatTypeback to summary
public ChatType chatType()

Record Component getter of chatType.

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).
fromback to summary
public static Optional<ChatIdentifier> from(BibDatabaseContext ctx, BibEntry entry)

Creates a ChatIdentifier for an entry if it has a valid AI library ID and a present, unique citation key.

Returns:Optional<ChatIdentifier>

Optional#empty() if the preconditions are not met

fromback to summary
public static Optional<ChatIdentifier> from(BibDatabaseContext ctx, GroupTreeNode group)

Creates a ChatIdentifier for a group if it has a valid AI library ID.

Returns:Optional<ChatIdentifier>

Optional#empty() if the preconditions are not met

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.

libraryIdback to summary
public String libraryId()

Record Component getter of libraryId.

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.