Package com.atlassian.bitbucket.markup

Enum Class UrlMode

java.lang.Object

java.lang.Enum<UrlMode>

com.atlassian.bitbucket.markup.UrlMode

All Implemented Interfaces:

Serializable, Comparable<UrlMode>, Constable

public enum UrlMode
extends Enum<UrlMode>

A formatting mode for URLs. Used to specify to MarkupService method what to do with generated URLs.

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
ABSOLUTE	Absolute URL format, with URL scheme, hostname, port (if non-standard for the scheme), and context path.
CONFIGURED	Configured URL format, always uses the system settings.
RELATIVE	Relative URL format, containing just the context path.

Method Summary

Modifier and Type	Method	Description
static UrlMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static UrlMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ABSOLUTE

public static final UrlMode ABSOLUTE

Absolute URL format, with URL scheme, hostname, port (if non-standard for the scheme), and context path.

RELATIVE

public static final UrlMode RELATIVE

Relative URL format, containing just the context path.

CONFIGURED

public static final UrlMode CONFIGURED

Configured URL format, always uses the system settings.

Method Details

values

public static UrlMode[] 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 UrlMode 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