org.springframework.http

Class ContentDisposition

java.lang.Object

org.springframework.http.ContentDisposition

public final class ContentDisposition
extends java.lang.Object

Represent the Content-Disposition type and parameters as defined in RFC 2183.

Since:

5.0

Author:

Sebastien Deleuze, Juergen Hoeller

See Also:

RFC 2183

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ContentDisposition.Builder A mutable builder for ContentDisposition.
private static class	ContentDisposition.BuilderImpl

Field Summary

Fields

Modifier and Type	Field and Description
private java.nio.charset.Charset	charset
private java.time.ZonedDateTime	creationDate
private java.lang.String	filename
private java.time.ZonedDateTime	modificationDate
private java.lang.String	name
private java.time.ZonedDateTime	readDate
private java.lang.Long	size
private java.lang.String	type

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ContentDisposition(java.lang.String type, java.lang.String name, java.lang.String filename, java.nio.charset.Charset charset, java.lang.Long size, java.time.ZonedDateTime creationDate, java.time.ZonedDateTime modificationDate, java.time.ZonedDateTime readDate) Private constructor.

Method Summary

Modifier and Type	Method and Description
static ContentDisposition.Builder	builder(java.lang.String type) Return a builder for a ContentDisposition.
private static java.lang.String	decodeHeaderFieldParam(java.lang.String input) Decode the given header field param as describe in RFC 5987.
static ContentDisposition	empty() Return an empty content disposition.
private static java.lang.String	encodeHeaderFieldParam(java.lang.String input, java.nio.charset.Charset charset) Encode the given header field param as describe in RFC 5987.
boolean	equals(java.lang.Object other)
java.nio.charset.Charset	getCharset() Return the charset defined in filename* parameter, or null if not defined.
java.time.ZonedDateTime	getCreationDate() Return the value of the creation-date parameter, or null if not defined.
java.lang.String	getFilename() Return the value of the filename parameter (or the value of the filename* one decoded as defined in the RFC 5987), or null if not defined.
java.time.ZonedDateTime	getModificationDate() Return the value of the modification-date parameter, or null if not defined.
java.lang.String	getName() Return the value of the name parameter, or null if not defined.
java.time.ZonedDateTime	getReadDate() Return the value of the read-date parameter, or null if not defined.
java.lang.Long	getSize() Return the value of the size parameter, or null if not defined.
java.lang.String	getType() Return the disposition type, like for example inline, attachment, form-data, or null if not defined.
int	hashCode()
private static boolean	isRFC5987AttrChar(byte c)
static ContentDisposition	parse(java.lang.String contentDisposition) Parse a Content-Disposition header value as defined in RFC 2183.
private static java.util.List<java.lang.String>	tokenize(java.lang.String headerValue)
java.lang.String	toString() Return the header value for this content disposition as defined in RFC 2183.

Methods inherited from class java.lang.Object

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

Field Detail

type

@Nullable
private final java.lang.String type

name

@Nullable
private final java.lang.String name

filename

@Nullable
private final java.lang.String filename

charset

@Nullable
private final java.nio.charset.Charset charset

size

@Nullable
private final java.lang.Long size

creationDate

@Nullable
private final java.time.ZonedDateTime creationDate

modificationDate

@Nullable
private final java.time.ZonedDateTime modificationDate

readDate

@Nullable
private final java.time.ZonedDateTime readDate

Constructor Detail

ContentDisposition

private ContentDisposition(@Nullable
                           java.lang.String type,
                           @Nullable
                           java.lang.String name,
                           @Nullable
                           java.lang.String filename,
                           @Nullable
                           java.nio.charset.Charset charset,
                           @Nullable
                           java.lang.Long size,
                           @Nullable
                           java.time.ZonedDateTime creationDate,
                           @Nullable
                           java.time.ZonedDateTime modificationDate,
                           @Nullable
                           java.time.ZonedDateTime readDate)

Private constructor. See static factory methods in this class.

Method Detail

getType

@Nullable
public java.lang.String getType()

Return the disposition type, like for example inline, attachment, form-data, or null if not defined.

getName

@Nullable
public java.lang.String getName()

Return the value of the name parameter, or null if not defined.

getFilename

@Nullable
public java.lang.String getFilename()

Return the value of the filename parameter (or the value of the filename* one decoded as defined in the RFC 5987), or null if not defined.

getCharset

@Nullable
public java.nio.charset.Charset getCharset()

Return the charset defined in filename* parameter, or null if not defined.

getSize

@Nullable
public java.lang.Long getSize()

Return the value of the size parameter, or null if not defined.

getCreationDate

@Nullable
public java.time.ZonedDateTime getCreationDate()

Return the value of the creation-date parameter, or null if not defined.

getModificationDate

@Nullable
public java.time.ZonedDateTime getModificationDate()

Return the value of the modification-date parameter, or null if not defined.

getReadDate

@Nullable
public java.time.ZonedDateTime getReadDate()

Return the value of the read-date parameter, or null if not defined.

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Return the header value for this content disposition as defined in RFC 2183.

Overrides:

toString in class java.lang.Object

See Also:

parse(String)

builder

public static ContentDisposition.Builder builder(java.lang.String type)

Return a builder for a ContentDisposition.

Parameters:

type - the disposition type like for example inline, attachment, or form-data

Returns:

the builder

empty

public static ContentDisposition empty()

Return an empty content disposition.

parse

public static ContentDisposition parse(java.lang.String contentDisposition)

Parse a Content-Disposition header value as defined in RFC 2183.

Parameters:

contentDisposition - the Content-Disposition header value

Returns:

the parsed content disposition

See Also:

toString()

tokenize

private static java.util.List<java.lang.String> tokenize(java.lang.String headerValue)

decodeHeaderFieldParam

private static java.lang.String decodeHeaderFieldParam(java.lang.String input)

Decode the given header field param as describe in RFC 5987.

Only the US-ASCII, UTF-8 and ISO-8859-1 charsets are supported.

Parameters:

input - the header field param

Returns:

the encoded header field param

See Also:

RFC 5987

isRFC5987AttrChar

private static boolean isRFC5987AttrChar(byte c)

encodeHeaderFieldParam

private static java.lang.String encodeHeaderFieldParam(java.lang.String input,
                                                       java.nio.charset.Charset charset)

Encode the given header field param as describe in RFC 5987.

Parameters:

input - the header field param

charset - the charset of the header field param string, only the US-ASCII, UTF-8 and ISO-8859-1 charsets are supported

Returns:

the encoded header field param

See Also:

RFC 5987