public final enum

UrlMode

extends Enum<E extends Enum<E>>
java.lang.Object
   ↳ java.lang.Enum<E extends java.lang.Enum<E>>
     ↳ com.atlassian.plugin.webresource.UrlMode

Class Overview

A formatting mode for URLs. Used to specify to WebResourceManager methods whether to use absolute URLs, relative URLs, or allow the concrete implementation to decide

Summary

Enum Values
UrlMode  ABSOLUTE  Absolute URL format, with URL scheme, hostname, port (if non-standard for the scheme), and context path. 
UrlMode  AUTO  Unspecified URL format, indicating that either absolute or relative URLs are acceptable. 
UrlMode  RELATIVE  Relative URL format, containing just the context path. 
Public Methods
static UrlMode valueOf(String name)
final static UrlMode[] values()
[Expand]
Inherited Methods
From class java.lang.Enum
From class java.lang.Object
From interface java.lang.Comparable

Enum Values

public static final UrlMode ABSOLUTE

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

public static final UrlMode AUTO

Unspecified URL format, indicating that either absolute or relative URLs are acceptable. Implementations are free to determine which mode to use based on any criteria of their choosing. For example, an implementation may choose to return a relative URL if it detects that it is running in the context of an HTTP request, and an absolute URL if it detects that it is not. Or it may choose to always return an absolute URL, or always return a relative URL. Callers should only use WebResourceManager.UrlMode#AUTO when they are sure that either an absolute or a relative URL will be appropriate, and should not rely on any particular observed behavior regarding how this value is interpreted, which may vary across different implementations.

public static final UrlMode RELATIVE

Relative URL format, containing just the context path.

Public Methods

public static UrlMode valueOf (String name)

public static final UrlMode[] values ()