Package org.apache.juneau.http.header

Class ContentDisposition.Builder

java.lang.Object

org.apache.juneau.http.header.ContentDisposition.Builder

Enclosing class:

ContentDisposition

public static class ContentDisposition.Builder
extends Object

Fluent builder for assembling an HTTP Content-Disposition header value.

Composes the disposition-type and parameters defined by RFC 6266 into the disposition-type; param=value; ... wire format. Typed setters cover the common parameters and apply the correct rendering (quoted-string for textual params, a bare number for size, and a raw RFC 5987 ext-value for filename*); param(String, String) is a generic escape hatch. Setters overwrite a previously-set parameter of the same name while preserving its original position.

Example:

String value = ContentDisposition.create() .attachment() .filename("genome.jpeg") .size(12345) .build(); // => "attachment; filename=\"genome.jpeg\"; size=12345"

See Also:

• ContentDisposition
• RFC 6266 - Use of the Content-Disposition Header Field

Since:

10.0.0

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ContentDisposition.Builder	attachment()	Sets the disposition-type to attachment.
String	build()	Builds the rendered Content-Disposition header value.
ContentDisposition.Builder	creationDate(String value)	Sets the creation-date parameter (rendered as a quoted HTTP-date).
ContentDisposition.Builder	filename(String value)	Sets the filename parameter (rendered as a quoted-string with backslash/quote escaping).
ContentDisposition.Builder	filenameExt(String value)	Sets the filename* parameter (rendered as a raw RFC 5987 ext-value, unquoted).
ContentDisposition.Builder	formData()	Sets the disposition-type to form-data.
ContentDisposition.Builder	inline()	Sets the disposition-type to inline.
ContentDisposition.Builder	modificationDate(String value)	Sets the modification-date parameter (rendered as a quoted HTTP-date).
ContentDisposition.Builder	name(String value)	Sets the name parameter (rendered as a quoted-string).
ContentDisposition.Builder	param(String name, String value)	Generic escape hatch for setting any parameter by name, rendered as a quoted-string.
ContentDisposition.Builder	readDate(String value)	Sets the read-date parameter (rendered as a quoted HTTP-date).
ContentDisposition.Builder	size(long value)	Sets the size parameter (rendered as a bare number).
ContentDisposition	toHeader()	Builds a ContentDisposition header bean directly from this builder.
String	toString()
ContentDisposition.Builder	type(String value)	Sets the disposition-type (e.g.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

type

public ContentDisposition.Builder type(String value)

Sets the disposition-type (e.g. "inline", "attachment", "form-data").

Parameters:

value - The disposition-type. Must not be null or blank.

Returns:

This object.

Throws:

IllegalArgumentException - If value is null or blank.

inline

public ContentDisposition.Builder inline()

Sets the disposition-type to inline.

Returns:

This object.

attachment

public ContentDisposition.Builder attachment()

Sets the disposition-type to attachment.

Returns:

This object.

formData

public ContentDisposition.Builder formData()

Sets the disposition-type to form-data.

Returns:

This object.

name

public ContentDisposition.Builder name(String value)

Sets the name parameter (rendered as a quoted-string).

Parameters:

value - The field name. Must not be null.

Returns:

This object.

filename

public ContentDisposition.Builder filename(String value)

Sets the filename parameter (rendered as a quoted-string with backslash/quote escaping).

Parameters:

value - The filename. Must not be null.

Returns:

This object.

filenameExt

public ContentDisposition.Builder filenameExt(String value)

Sets the filename* parameter (rendered as a raw RFC 5987 ext-value, unquoted).

Parameters:

value - The encoded ext-value (e.g. "UTF-8''%e2%82%ac%20rates"). Must not be null.

Returns:

This object.

creationDate

public ContentDisposition.Builder creationDate(String value)

Sets the creation-date parameter (rendered as a quoted HTTP-date).

Parameters:

value - The creation date. Must not be null.

Returns:

This object.

modificationDate

public ContentDisposition.Builder modificationDate(String value)

Sets the modification-date parameter (rendered as a quoted HTTP-date).

Parameters:

value - The modification date. Must not be null.

Returns:

This object.

readDate

public ContentDisposition.Builder readDate(String value)

Sets the read-date parameter (rendered as a quoted HTTP-date).

Parameters:

value - The read date. Must not be null.

Returns:

This object.

size

public ContentDisposition.Builder size(long value)

Sets the size parameter (rendered as a bare number).

Parameters:

value - The size in bytes. Must be non-negative.

Returns:

This object.

Throws:

IllegalArgumentException - If value is negative.

param

public ContentDisposition.Builder param(String name,
 String value)

Generic escape hatch for setting any parameter by name, rendered as a quoted-string.

Replaces any previously-registered value for the same parameter while preserving its original position.

Parameters:

name - The parameter name. Must not be null or blank.

value - The parameter value (quoted automatically). Must not be null.

Returns:

This object.

Throws:

IllegalArgumentException - If name is null or blank.

build

public String build()

Builds the rendered Content-Disposition header value.

Returns an empty string when no disposition-type or parameters have been registered.

Returns:

The header value. Never null.

toHeader

public ContentDisposition toHeader()

Builds a ContentDisposition header bean directly from this builder.

Returns:

A ContentDisposition carrying build(). Never null.

toString

public String toString()

Overrides:

toString in class Object