Record Class AsyncChannel

java.lang.Object
java.lang.Record
com.arc_e_tect.gradle.apionly.transcriberj.model.AsyncChannel
Record Components:
key - its key under channels, as the bundler chose it
provenance - where the channel fragment came from
address - address, the address on the broker, or null
title - title, or null
description - description, or null
messages - the messages it carries, in declaration order
location - the JSON pointer of the channel in its document

public record AsyncChannel(String key, Provenance provenance, String address, String title, String description, List<AsyncMessage> messages, String location) extends Record
A channel of an AsyncAPI contract: an address messages travel over.
  • Constructor Details

    • AsyncChannel

      public AsyncChannel(String key, Provenance provenance, String address, String title, String description, List<AsyncMessage> messages, String location)
      Creates an instance of a AsyncChannel record class.
      Parameters:
      key - the value for the key record component
      provenance - the value for the provenance record component
      address - the value for the address record component
      title - the value for the title record component
      description - the value for the description record component
      messages - the value for the messages record component
      location - the value for the location 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.
    • key

      public String key()
      Returns the value of the key record component.
      Returns:
      the value of the key record component
    • provenance

      public Provenance provenance()
      Returns the value of the provenance record component.
      Returns:
      the value of the provenance record component
    • address

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

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

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

      public List<AsyncMessage> messages()
      Returns the value of the messages record component.
      Returns:
      the value of the messages record component
    • location

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