Record Class AddressableAttachment

java.lang.Object
java.lang.Record
com.atlassian.confluence.pages.AddressableAttachment
All Implemented Interfaces:
Addressable

public record AddressableAttachment(Attachment attachment) extends Record implements Addressable
Since:
9.3
  • Field Details

  • Constructor Details

    • AddressableAttachment

      public AddressableAttachment(Attachment attachment)
      Creates an instance of a AddressableAttachment record class.
      Parameters:
      attachment - the value for the attachment record component
  • Method Details

    • of

      public static AddressableAttachment of(Attachment attachment)
    • getId

      public long getId()
      Specified by:
      getId in interface Addressable
    • getDisplayTitle

      public String getDisplayTitle()
      Specified by:
      getDisplayTitle in interface Addressable
      Returns:
      the title of the addressable object, suitable for display in a list
    • getUrlPath

      public String getUrlPath()
      Specified by:
      getUrlPath in interface Addressable
    • getDownloadPath

      public String getDownloadPath()
    • getDownloadPathWithoutVersion

      public String getDownloadPathWithoutVersion()
      Returns the download path without any version info.
    • getDownloadPathWithoutVersionOrApiRevision

      public String getDownloadPathWithoutVersionOrApiRevision()
      Returns the download path without any version info or API revision.
    • getDownloadPath

      public String getDownloadPath(String attachmentPath, boolean addVersionInfo)
      Returns the download path of the attachment for a given attachmentPath prefix. It basically appends the filename and some meta info to form the path.
    • getDownloadPathWithoutEncoding

      public String getDownloadPathWithoutEncoding()
    • getExportPath

      public String getExportPath()
    • getExportPathForThumbnail

      public String getExportPathForThumbnail()
    • 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.
    • attachment

      public Attachment attachment()
      Returns the value of the attachment record component.
      Returns:
      the value of the attachment record component