Package net.ygbstudio.jbrave.core.model

Record Class BraveSearchOption<V>

java.lang.Object
java.lang.Record
net.ygbstudio.jbrave.core.model.BraveSearchOption<V>
Type Parameters:
V - type of the parameter value for a search option.
Record Components:
option - the search option key
value - the search option value
All Implemented Interfaces:
SearchOptionCarrier<V>
public record BraveSearchOption<V>(SearchOption option, V value) extends Record implements SearchOptionCarrier<V>
A search option that can be used in the search methods.

It is typically used as a factory for the SearchOptions implementation.

  • Constructor Details

    • BraveSearchOption

      public BraveSearchOption(SearchOption option, V value)
      Creates an instance of a BraveSearchOption record class.
      Parameters:
      option - the value for the option record component
      value - the value for the value record component

  • Method Details

    • of

      @Contract("_, _ -> new") @NotNull public static <V> @NotNull BraveSearchOption<V> of(SearchOption key, V value)
      Creates a new BraveSearchOption with the given key and value.
      Type Parameters:
      V - the type of the value
      Parameters:
      key - the search option key
      value - the value of the search option
      Returns:
      a new BraveSearchOption

    • buildParam

      public String buildParam()
      Builds the URL parameter for this search option.
      Specified by:
      buildParam in interface SearchOptionCarrier<V>
      Returns:
      the URL parameter for this search option

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • option

      public SearchOption option()
      Returns the value of the option record component.
      Specified by:
      option in interface SearchOptionCarrier<V>
      Returns:
      the value of the option record component

    • value

      public V value()
      Returns the value of the value record component.
      Specified by:
      value in interface SearchOptionCarrier<V>
      Returns:
      the value of the value record component