Package net.voidnote

Record Class ReadResult

java.lang.Object
java.lang.Record
net.voidnote.ReadResult
Record Components:
content - Decrypted plaintext.
title - Note title, or null if not set.
viewCount - How many times this note has been read.
maxViews - View limit before destruction.
destroyed - true if the view limit was reached after this read.
public record ReadResult(String content, String title, int viewCount, int maxViews, boolean destroyed) extends Record
Decrypted content of a VoidNote.

  • Constructor Details

    • ReadResult

      public ReadResult(String content, String title, int viewCount, int maxViews, boolean destroyed)
      Creates an instance of a ReadResult record class.
      Parameters:
      content - the value for the content record component
      title - the value for the title record component
      viewCount - the value for the viewCount record component
      maxViews - the value for the maxViews record component
      destroyed - the value for the destroyed 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. 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.

    • content

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

    • title

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

    • viewCount

      public int viewCount()
      Returns the value of the viewCount record component.
      Returns:
      the value of the viewCount record component

    • maxViews

      public int maxViews()
      Returns the value of the maxViews record component.
      Returns:
      the value of the maxViews record component

    • destroyed

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