Package com.gentics.contentnode.rest.resource

Record Class BinaryOutput

java.lang.Object
java.lang.Record
com.gentics.contentnode.rest.resource.BinaryOutput
Record Components:
inputStream - The input stream to read data from for the response.
All Implemented Interfaces:
jakarta.ws.rs.core.StreamingOutput
public record BinaryOutput(InputStream inputStream) extends Record implements jakarta.ws.rs.core.StreamingOutput
Implementation of StreamingOutput to be used for binary downloads.

Note: Accessing the inputStream() is only intended for testing when the Response object from the binary download endpoint is used directly instead of being sent via HTTP to a client.

  • Constructor Details

    • BinaryOutput

      public BinaryOutput(InputStream inputStream)
      Creates an instance of a BinaryOutput record class.
      Parameters:
      inputStream - the value for the inputStream record component

  • Method Details

    • write

      public void write(OutputStream outputStream) throws jakarta.ws.rs.WebApplicationException
      Specified by:
      write in interface jakarta.ws.rs.core.StreamingOutput
      Throws:
      jakarta.ws.rs.WebApplicationException

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

    • inputStream

      public InputStream inputStream()
      Returns the value of the inputStream record component.
      Returns:
      the value of the inputStream record component