Class HalLinks

java.lang.Object
com.helixframework.api.contract.HalLinks

public final class HalLinks extends Object
Represents a collection of HAL (Hypertext Application Language) links. Each entry maps a link relation (rel) to a HalLink instance. This container serializes to the canonical "_links" JSON structure in HAL. Example JSON: { "_links": { "self": { "href": "/orders/123" }, "update": { "href": "/orders/123", "meta": { "method": "PUT" } } } }
  • Method Details

    • builder

      public static HalLinks.Builder builder()
      Creates a new empty builder for constructing HalLinks.
      Returns:
      a new Builder instance
    • builder

      public static HalLinks.Builder builder(HalLinks links)
      Creates a new builder initialized with the links of the given instance.
      Parameters:
      links - links to copy from
      Returns:
      a new Builder instance
    • of

      public static HalLinks of(Map<String,HalLink> links)
      Creates a new HalLinks instance with the given links.
      Parameters:
      links - links to include
      Returns:
      a new HalLinks instance
    • self

      public static HalLinks self(HalLink self)
      Convenience factory for a single self link.
    • getLinks

      public Map<String,HalLink> getLinks()
      Returns the internal map of rel → HalLink entries.
      Returns:
      Unmodifiable map of links
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object