Package io.github.dornol.excelkit.excel

Record Class ExcelHyperlink

java.lang.Object
java.lang.Record
io.github.dornol.excelkit.excel.ExcelHyperlink
Record Components:
url - the hyperlink URL
label - the display text shown in the cell
public record ExcelHyperlink(String url, String label) extends Record
Represents a hyperlink value for Excel cells.

Use with ExcelDataType.HYPERLINK to create clickable links in Excel. If only a URL is provided, it is used as both the display label and the link target. 


 writer.column("Website", user -> new ExcelHyperlink(user.getUrl(), "Visit"))
       .type(ExcelDataType.HYPERLINK)
       .write(stream);

  • Constructor Summary

    Constructors
    Constructor
    Description
    ExcelHyperlink(String url)
    Creates a hyperlink where the URL is also used as the display label.
    ExcelHyperlink(String url, String label)
    Creates an instance of a ExcelHyperlink record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    label()
    Returns the value of the label record component.
    final String
    toString()
    Returns a string representation of this record class.
    String
    url()
    Returns the value of the url record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ExcelHyperlink

      public ExcelHyperlink(String url)
      Creates a hyperlink where the URL is also used as the display label.
      Parameters:
      url - the hyperlink URL

    • ExcelHyperlink

      public ExcelHyperlink(String url, String label)
      Creates an instance of a ExcelHyperlink record class.
      Parameters:
      url - the value for the url record component
      label - the value for the label 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.

    • url

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

    • label

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