Record Class Observed

java.lang.Object
java.lang.Record
net.ixdarklord.folios.internal.client.page.Observed
public record Observed(net.minecraft.resources.Identifier source, @Nullable String of, String row, String header, String footer, String separator, @Nullable String sort, @Nullable com.google.gson.JsonObject where, int limit, String empty) extends Record
An element's "observe": text written from a live list (FoliosSources), a line of markup for each of its rows, put after the element's own text and written again whenever the list changes. 
"observe": {
  "source": "whycantisleep:sleep_modifiers", "of": "...",
  "row": "- **{$name}** ({$points}): {$description}",
  "sort": "name", "where": {"field": "points", "below": 0}, "limit": 10,
  "header": "...", "footer": "...", "separator": "\n", "empty": "*None yet.*"
}
"of" narrows a source Folios gives itself (folios:items of a tag, say: see FoliosBuiltinSources). {$field} is a row's field (its id too); a field holding a translation key is translated. sort names a field ("-name" for the other way; numbers sort as numbers); where keeps rows whose field is, is not, is above or below a value.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Observed(net.minecraft.resources.Identifier source, @Nullable String of, String row, String header, String footer, String separator, @Nullable String sort, @Nullable com.google.gson.JsonObject where, int limit, String empty)
    Creates an instance of a Observed record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    empty()
    Returns the value of the empty record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    String
    footer()
    Returns the value of the footer record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    header()
    Returns the value of the header record component.
    int
    limit()
    Returns the value of the limit record component.
    @Nullable String
    of()
    Returns the value of the of record component.
    static @Nullable Observed
    read(com.google.gson.JsonObject json)
    What a page's or an element's JSON observes; null for one that observes nothing.
    String
    row()
    Returns the value of the row record component.
    String
    separator()
    Returns the value of the separator record component.
    @Nullable String
    sort()
    Returns the value of the sort record component.
    net.minecraft.resources.Identifier
    source()
    Returns the value of the source record component.
    String
    text()
    The text as the list is now.
    final String
    toString()
    Returns a string representation of this record class.
    @Nullable com.google.gson.JsonObject
    where()
    Returns the value of the where record component.

    Methods inherited from class Object

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

  • Constructor Details

    • Observed

      public Observed(net.minecraft.resources.Identifier source, @Nullable String of, String row, String header, String footer, String separator, @Nullable String sort, @Nullable com.google.gson.JsonObject where, int limit, String empty)
      Creates an instance of a Observed record class.
      Parameters:
      source - the value for the source record component
      of - the value for the of record component
      row - the value for the row record component
      header - the value for the header record component
      footer - the value for the footer record component
      separator - the value for the separator record component
      sort - the value for the sort record component
      where - the value for the where record component
      limit - the value for the limit record component
      empty - the value for the empty record component

  • Method Details

    • read

      public static @Nullable Observed read(com.google.gson.JsonObject json)
      What a page's or an element's JSON observes; null for one that observes nothing.

    • text

      public String text()
      The text as the list is now.

    • 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 the compare method from their corresponding wrapper classes.
      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.

    • source

      public net.minecraft.resources.Identifier source()
      Returns the value of the source record component.
      Returns:
      the value of the source record component

    • of

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

    • row

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

    • header

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

    • footer

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

    • separator

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

    • sort

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

    • where

      public @Nullable com.google.gson.JsonObject where()
      Returns the value of the where record component.
      Returns:
      the value of the where record component

    • limit

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

    • empty

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