Package org.apache.logging.log4j.plugins.model

Record Class PluginEntry

java.lang.Object
java.lang.Record
org.apache.logging.log4j.plugins.model.PluginEntry
All Implemented Interfaces:
Comparable<PluginEntry>
public record PluginEntry(String key, String className, String name, String elementType, boolean printable, boolean deferChildren, String namespace) extends Record implements Comparable<PluginEntry>
Descriptor for Plugin metadata.

  • Constructor Details

    • PluginEntry

      public PluginEntry(String key, String className, String name, String elementType, boolean printable, boolean deferChildren, String namespace)
      Creates an instance of a PluginEntry record class.
      Parameters:
      key - the value for the key record component
      className - the value for the className record component
      name - the value for the name record component
      elementType - the value for the elementType record component
      printable - the value for the printable record component
      deferChildren - the value for the deferChildren record component
      namespace - the value for the namespace record component

  • Method Details

    • compareTo

      public int compareTo(PluginEntry o)
      Specified by:
      compareTo in interface Comparable<PluginEntry>

    • builder

      public static PluginEntry.Builder builder()

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • key

      public String key()
      Returns the value of the key record component.
      Returns:
      the value of the key record component

    • className

      public String className()
      Returns the value of the className record component.
      Returns:
      the value of the className record component

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • elementType

      public String elementType()
      Returns the value of the elementType record component.
      Returns:
      the value of the elementType record component

    • printable

      public boolean printable()
      Returns the value of the printable record component.
      Returns:
      the value of the printable record component

    • deferChildren

      public boolean deferChildren()
      Returns the value of the deferChildren record component.
      Returns:
      the value of the deferChildren record component

    • namespace

      public String namespace()
      Returns the value of the namespace record component.
      Returns:
      the value of the namespace record component