Package org.apache.juneau.http.header

Class ContentDisposition

java.lang.Object

org.apache.juneau.http.header.HttpHeaderBean

org.apache.juneau.http.header.HttpStringRangesHeader

org.apache.juneau.http.header.ContentDisposition

All Implemented Interfaces:

HttpHeader

public class ContentDisposition
extends HttpStringRangesHeader

Represents an HTTP Content-Disposition header.

Content disposition (inline / attachment / filename).

Since:

9.2.1

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ContentDisposition.Builder	Fluent builder for assembling an HTTP Content-Disposition header value.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Fields inherited from class org.apache.juneau.http.header.HttpStringRangesHeader

LAZY_STRING_RANGES, LAZY_WIRE_STRING

Constructor Summary

Constructors

Constructor	Description
ContentDisposition(String value)
ContentDisposition(StringRanges value)

Method Summary

Modifier and Type	Method	Description
static ContentDisposition	attachment(String filename)	Returns a Content-Disposition header value of the form attachment; filename="<filename>" with the file name properly escaped (backslashes and double-quotes are backslash-escaped).
static ContentDisposition.Builder	create()	Creates a new empty ContentDisposition.Builder.
static ContentDisposition	of(String value)
static ContentDisposition	of(StringRanges value)
static ContentDisposition	ofLazyParsed(Supplier<StringRanges> supplier)
static ContentDisposition	ofLazyWire(Supplier<String> supplier)

Methods inherited from class org.apache.juneau.http.header.HttpStringRangesHeader

asStringRanges, getRange, match, of, of, orElse, toStringRanges

Methods inherited from class org.apache.juneau.http.header.HttpHeaderBean

equals, equalsIgnoreCase, getName, getValue, hashCode, of, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

ContentDisposition

public ContentDisposition(String value)

ContentDisposition

public ContentDisposition(StringRanges value)

Method Details

of

public static ContentDisposition of(String value)

of

public static ContentDisposition of(StringRanges value)

ofLazyWire

public static ContentDisposition ofLazyWire(Supplier<String> supplier)

ofLazyParsed

public static ContentDisposition ofLazyParsed(Supplier<StringRanges> supplier)

attachment

public static ContentDisposition attachment(String filename)

Returns a Content-Disposition header value of the form attachment; filename="<filename>" with the file name properly escaped (backslashes and double-quotes are backslash-escaped).

Parameters:

filename - The attachment filename. Must not be null, blank, or contain CR/LF characters.

Returns:

A new ContentDisposition header.

Throws:

IllegalArgumentException - If filename is invalid.

create

public static ContentDisposition.Builder create()

Creates a new empty ContentDisposition.Builder.

Returns:

A new builder. Never null.