com.github.michaelbull.rs.bestiary

Class SearchResult

java.lang.Object

com.github.michaelbull.rs.bestiary.SearchResult

public final class SearchResult
extends java.lang.Object

Represents a result returned by searching within the RuneScape Bestiary.

Constructor Summary

Constructors

Constructor and Description
SearchResult(int value, java.lang.String label) Creates a new SearchResult.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.util.Optional<java.lang.String>	getLabel() Gets an Optional containing the result's label.
int	getValue() Gets the value of the result.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SearchResult

public SearchResult(int value,
                    java.lang.String label)

Creates a new SearchResult.

Parameters:

value - The value of the result.

label - The label of the result.

Method Detail

getValue

public int getValue()

Gets the value of the result.

Returns:

The value of the result.

getLabel

public java.util.Optional<java.lang.String> getLabel()

Gets an Optional containing the result's label.

Returns:

An Optional containing the result's label, or Optional.empty() if no label was found.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object