Package org.apache.poi.common.usermodel

Enum HyperlinkType

java.lang.Object

java.lang.Enum<HyperlinkType>

org.apache.poi.common.usermodel.HyperlinkType

All Implemented Interfaces:

Serializable, Comparable<HyperlinkType>, java.lang.constant.Constable

public enum HyperlinkType
extends Enum<HyperlinkType>

Since:

POI 3.15 beta 3

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

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

Modifier and Type	Method	Description
static HyperlinkType	valueOf(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

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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 type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static HyperlinkType valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null