Enum Class HyperlinkType

java.lang.Object
java.lang.Enum<HyperlinkType>
org.apache.poi.common.usermodel.HyperlinkType
All Implemented Interfaces:
Serializable, Comparable<HyperlinkType>, Constable

public enum HyperlinkType extends Enum<HyperlinkType>
Since:
POI 3.15 beta 3
  • Enum Constant Details

    • NONE

      @Internal public static final HyperlinkType NONE
      Not a hyperlink
    • URL

      public static final HyperlinkType URL
      Link to an existing file or web page
    • DOCUMENT

      public static final HyperlinkType DOCUMENT
      Link to a place in this document
    • EMAIL

      public static final HyperlinkType EMAIL
      Link to an E-mail address
    • FILE

      public static final HyperlinkType FILE
      Link to a file
  • Method Details

    • values

      public static HyperlinkType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static HyperlinkType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null
    • getCode

      @Internal(since="3.15 beta 3") @Deprecated public int getCode()
      Deprecated.
      POI 3.15 beta 3
      Returns:
      the old integer code for a HyperlinkType enum
    • forInt

      @Internal(since="3.15 beta 3") @Deprecated public static HyperlinkType forInt(int code)
      Deprecated.
      POI 3.15 beta 3
      Parameters:
      code - the old integer code
      Returns:
      the corresponding HyperlinkEnum, if it exists
      Throws:
      IllegalArgumentException - if code is not a valid HyperlinkType.