Package org.apache.poi.common.usermodel

Enum HyperlinkType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<HyperlinkType>
    public enum HyperlinkType
extends java.lang.Enum<HyperlinkType>
    Since:
    POI 3.15 beta 3

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DOCUMENT
      Link to a place in this document
      EMAIL
      Link to an E-mail address.
      FILE
      Link to a file
      NONE
      Not a hyperlink
      URL
      Link to an existing file or web page

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static HyperlinkType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static HyperlinkType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • 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. Please note that this currently only works if the address in the hyperlink uses the prefix "mailto:" as the binary formats do not persis this type.

    • Method Detail

      • values

        public static HyperlinkType[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (HyperlinkType c : HyperlinkType.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static HyperlinkType valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null