Package io.fluxzero.tools.jsondoclet.model

Record Class DirectoryIndex.IndexFileEntry

java.lang.Object
java.lang.Record
io.fluxzero.tools.jsondoclet.model.DirectoryIndex.IndexFileEntry
Enclosing class:
DirectoryIndex
public static record DirectoryIndex.IndexFileEntry(String file, String name, String qualifiedName, String kind) extends Record
Simple file entry describing nearby JSON output.

  • Constructor Summary

    Constructors
    Constructor
    Description
    IndexFileEntry(String file, String name, String qualifiedName, String kind)
    Creates an instance of a IndexFileEntry record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    String
    file()
    Returns the value of the file record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    kind()
    Returns the value of the kind record component.
    String
    name()
    Returns the value of the name record component.
    String
    qualifiedName()
    Returns the value of the qualifiedName record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • IndexFileEntry

      public IndexFileEntry(String file, String name, String qualifiedName, String kind)
      Creates an instance of a IndexFileEntry record class.
      Parameters:
      file - the value for the file record component
      name - the value for the name record component
      qualifiedName - the value for the qualifiedName record component
      kind - the value for the kind record component

  • Method Details

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

    • file

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

    • name

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

    • qualifiedName

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

    • kind

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