Package org.apache.logging.log4j.kit.recycler

Record Class RecyclerProperties

java.lang.Object
java.lang.Record
org.apache.logging.log4j.kit.recycler.RecyclerProperties
Record Components:
factory - The name of the recycler factory to use (cf. RecyclerFactoryProvider.getName()),
capacity - The capacity of the recycler.
@NullMarked @Log4jProperty(name="recycler") public record RecyclerProperties(@Nullable String factory, @Nullable Integer capacity) extends Record
A set of common configuration options for recyclers

  • Constructor Details

    • RecyclerProperties

      public RecyclerProperties(@Nullable String factory, @Nullable Integer capacity)
      Creates an instance of a RecyclerProperties record class.
      Parameters:
      factory - the value for the factory record component
      capacity - the value for the capacity record component

  • Method Details

    • capacity

      public Integer capacity()
      Returns the value of the capacity record component.
      Returns:
      the value of the capacity record component

    • 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.

    • factory

      public @Nullable String factory()
      Returns the value of the factory record component.
      Returns:
      the value of the factory record component