Module org.htmlunit

Package org.htmlunit

Enum Class WebRequest.FetchDestination

java.lang.Object

java.lang.Enum<WebRequest.FetchDestination>

org.htmlunit.WebRequest.FetchDestination

All Implemented Interfaces:

Serializable, Comparable<WebRequest.FetchDestination>, Constable

Enclosing class:

WebRequest

public static enum WebRequest.FetchDestination
extends Enum<WebRequest.FetchDestination>

The destination of a request, as defined by the Fetch spec ( https://fetch.spec.whatwg.org/#concept-request-destination).

This is used to compute the value of the Sec-Fetch-Dest request header (see https://www.w3.org/TR/fetch-metadata/) and also determines the default WebRequest.FetchMode to be used, unless explicitly overridden via WebRequest.setFetchModeOverride(FetchMode).

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
AUDIO	An <audio> resource.
DOCUMENT	A top-level document, e.g. loaded by the address bar, a link, or a form submission.
EMBED	An <embed> element.
EMPTY	No specific destination, e.g.
FONT	A font resource, e.g. loaded via @font-face.
FRAME	A nested browsing context of type <frame>.
IFRAME	A nested browsing context of type <iframe>.
IMAGE	An image, e.g.
MANIFEST	A web app manifest, e.g.
OBJECT	An <object> element.
REPORT	A reporting endpoint request.
SCRIPT	A classic or module script, e.g.
SERVICE_WORKER	A service worker script.
SHARED_WORKER	A shared worker script.
STYLE	A stylesheet, e.g.
TRACK	A <track> resource.
VIDEO	A <video> resource.
WEBSOCKET	A WebSocket handshake request.
WORKER	A dedicated worker script.

Method Summary

Modifier and Type	Method	Description
String	getValue()	Returns the value to be used for the Sec-Fetch-Dest header.
static WebRequest.FetchDestination	valueOf(String name)	Returns the enum constant of this class with the specified name.
static WebRequest.FetchDestination[]	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

DOCUMENT

public static final WebRequest.FetchDestination DOCUMENT

A top-level document, e.g. loaded by the address bar, a link, or a form submission.

IFRAME

public static final WebRequest.FetchDestination IFRAME

A nested browsing context of type <iframe>.

FRAME

public static final WebRequest.FetchDestination FRAME

A nested browsing context of type <frame>.

OBJECT

public static final WebRequest.FetchDestination OBJECT

An <object> element.

EMBED

public static final WebRequest.FetchDestination EMBED

An <embed> element.

IMAGE

public static final WebRequest.FetchDestination IMAGE

An image, e.g. <img>, a CSS background-image, or a favicon.

SCRIPT

public static final WebRequest.FetchDestination SCRIPT

A classic or module script, e.g. <script src>.

STYLE

public static final WebRequest.FetchDestination STYLE

A stylesheet, e.g. <link rel=stylesheet> or a CSS @import.

FONT

public static final WebRequest.FetchDestination FONT

A font resource, e.g. loaded via @font-face.

AUDIO

public static final WebRequest.FetchDestination AUDIO

An <audio> resource.

VIDEO

public static final WebRequest.FetchDestination VIDEO

A <video> resource.

TRACK

public static final WebRequest.FetchDestination TRACK

A <track> resource.

WORKER

public static final WebRequest.FetchDestination WORKER

A dedicated worker script.

SHARED_WORKER

public static final WebRequest.FetchDestination SHARED_WORKER

A shared worker script.

SERVICE_WORKER

public static final WebRequest.FetchDestination SERVICE_WORKER

A service worker script.

MANIFEST

public static final WebRequest.FetchDestination MANIFEST

A web app manifest, e.g. <link rel=manifest>.

REPORT

public static final WebRequest.FetchDestination REPORT

A reporting endpoint request.

WEBSOCKET

public static final WebRequest.FetchDestination WEBSOCKET

A WebSocket handshake request.

EMPTY

public static final WebRequest.FetchDestination EMPTY

No specific destination, e.g. XMLHttpRequest or fetch().

Method Details

values

public static WebRequest.FetchDestination[] 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 WebRequest.FetchDestination 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

getValue

public String getValue()

Returns the value to be used for the Sec-Fetch-Dest header.

Returns:

the value to be used for the Sec-Fetch-Dest header