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

public final Record UserHostInfo

extends Record
Class Inheritance
Annotations
@NullMarked
Record Components
user:String 
host:String 
Imports
org.jspecify.annotations.NullMarked

Record to represent user and host information. This is used to identify the user when retrieving file directories.

Field Summary

Modifier and TypeField and Description
private final String
host

Record Component accessed by host().

private final String
user

Record Component accessed by user().

Constructor Summary

AccessConstructor and Description
public

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 String

Returns:

the user-host string
getUserHostString
()

Returns the user-host string representation.

public final int
hashCode()

Implements abstract java.lang.Record.hashCode.

Returns a hash code value for the record.

public boolean

Returns:

true if the hosts are the same and not empty, false otherwise
hasSameHost
(UserHostInfo
the other UserHostInfo
other
)

Checks if this UserHostInfo has the same host as the given UserHostInfo.

public String
host()

Record Component getter of host.

public static UserHostInfo

Returns:

a new UserHostInfo
parse
(String
the user-host string
userHostString
)

Creates a new UserHostInfo from a user-host string.

public String
toString()

Implements abstract java.lang.Record.toString.

Returns a string representation of the record.

public String
user()

Record Component getter of user.

Field Detail

hostback to summary
private final String host

Record Component accessed by host().

userback to summary
private final String user

Record Component accessed by user().

Constructor Detail

UserHostInfoback to summary
public UserHostInfo(String user, String host)

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).
getUserHostStringback to summary
public String getUserHostString()

Returns the user-host string representation. If the host is empty, only the user is returned. Otherwise, the format is "user-host".

Returns:String

the user-host string

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.

hasSameHostback to summary
public boolean hasSameHost(UserHostInfo other)

Checks if this UserHostInfo has the same host as the given UserHostInfo.

Parameters
other:UserHostInfo

the other UserHostInfo

Returns:boolean

true if the hosts are the same and not empty, false otherwise

hostback to summary
public String host()

Record Component getter of host.

parseback to summary
public static UserHostInfo parse(String userHostString)

Creates a new UserHostInfo from a user-host string. The user-host string is expected to be in the format "user-host". If the string does not contain a hyphen, the entire string is considered as the user and the host is empty.

Parameters
userHostString:String

the user-host string

Returns:UserHostInfo

a new UserHostInfo

toStringback to summary
public 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.

Annotations
@Override
userback to summary
public String user()

Record Component getter of user.