Record Class SymbolRegistryEntry

java.lang.Object
java.lang.Record
com.bluebell.greenhouse.platform.models.core.nonentities.symbol.SymbolRegistryEntry
Record Components:
id - unique identifier
category - registry category that contains the entry
name - symbol or instrument name
ticker - ticker or code
description - researched description
exchange - exchange MIC
instrumentType - instrument type code
website - issuer or instrument website
active - true when the entry is active
sourceUrls - sources used to enrich the entry
aliases - symbol aliases
confidence - enrichment confidence value
needsReview - true when the entry still requires review
public record SymbolRegistryEntry(String id, String category, String name, String ticker, String description, String exchange, String instrumentType, String website, boolean active, List<String> sourceUrls, List<SymbolRegistryAliasEntry> aliases, Double confidence, boolean needsReview) extends Record
Represents a single entry from the symbol registry JSON document.
Version:
2.0.2
Author:
Stephen Prizio

  • Constructor Details

  • Method Details

    • fromId

      public SymbolRegistryEntry fromId(String resolvedId, SymbolRegistryEntry toMerge)
      Copies the given registry entry with the supplied id.
      Parameters:
      resolvedId - id to apply
      toMerge - source entry
      Returns:
      SymbolRegistryEntry

    • withId

      public SymbolRegistryEntry withId(String resolvedId)
      Copies this registry entry with the supplied id.
      Parameters:
      resolvedId - id to apply
      Returns:
      SymbolRegistryEntry

    • withCategory

      public SymbolRegistryEntry withCategory(String resolvedCategory)
      Copies this registry entry with the supplied category.
      Parameters:
      resolvedCategory - category to apply
      Returns:
      SymbolRegistryEntry

    • withAliases

      public SymbolRegistryEntry withAliases(List<SymbolRegistryAliasEntry> resolvedAliases)
      Copies this registry entry with the supplied aliases.
      Parameters:
      resolvedAliases - aliases to apply
      Returns:
      SymbolRegistryEntry

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

    • id

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

    • category

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

    • name

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

    • ticker

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

    • description

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

    • exchange

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

    • instrumentType

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

    • website

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

    • active

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

    • sourceUrls

      public List<String> sourceUrls()
      Returns the value of the sourceUrls record component.
      Returns:
      the value of the sourceUrls record component

    • aliases

      public List<SymbolRegistryAliasEntry> aliases()
      Returns the value of the aliases record component.
      Returns:
      the value of the aliases record component

    • confidence

      public Double confidence()
      Returns the value of the confidence record component.
      Returns:
      the value of the confidence record component

    • needsReview

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