Class MultipartField

java.lang.Object

com.soklet.MultipartField

@ThreadSafe
public final class MultipartField
extends Object

Encapsulates an HTML form element name, binary and String representations of its value, and other attributes as encoded according to the multipart/form-data specification.

Instances can be acquired via these builder factory methods:

• withName(String) (with form element name)
• with(String, byte[]) (with form element name and value)

Full documentation is available at https://www.soklet.com/docs/request-handling#multipart-form-data.

Author:

Mark Allen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MultipartField.Builder	Builder used to construct instances of MultipartField via withName(String) or with(String, byte[]).
static final class	MultipartField.Copier	Builder used to copy instances of MultipartField via copy().

Method Summary

Modifier and Type	Method	Description
MultipartField.Copier	copy()	Vends a mutable copier seeded with this instance's data, suitable for building new instances.
boolean	equals(Object object)
Optional<Charset>	getCharset()	The charset used to encode this field, if applicable.
Optional<String>	getContentType()	The content type for this field, if available (for example, image/png for an image file).
Optional<byte[]>	getData()	The binary value of this field, if available.
Optional<String>	getDataAsString()	The value of this field represented as a string, if available.
Optional<String>	getFilename()	The filename associated with this field, if available.
String	getName()	The name of this field.
int	hashCode()
String	toString()
static MultipartField.Builder	with(String name, byte[] value)	Acquires a builder for MultipartField instances.
static MultipartField.Builder	withName(String name)	Acquires a builder for MultipartField instances.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

withName

@Nonnull
public static MultipartField.Builder withName(@Nonnull
 String name)

Acquires a builder for MultipartField instances.

Parameters:

name - the name of this field

Returns:

the builder

with

@Nonnull
public static MultipartField.Builder with(@Nonnull
 String name,
 @Nullable
 byte[] value)

Acquires a builder for MultipartField instances.

Parameters:

name - the name of this field

value - the optional value for this field

Returns:

the builder

copy

@Nonnull
public MultipartField.Copier copy()

Vends a mutable copier seeded with this instance's data, suitable for building new instances.

Returns:

a copier for this instance

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(@Nullable
 Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getDataAsString

@Nonnull
public Optional<String> getDataAsString()

The value of this field represented as a string, if available.

Returns:

the string value, or Optional.empty() if not available

getName

@Nonnull
public String getName()

The name of this field.

Returns:

the name of this field

getFilename

@Nonnull
public Optional<String> getFilename()

The filename associated with this field, if available.

Returns:

the filename, or Optional.empty() if not available

getContentType

@Nonnull
public Optional<String> getContentType()

The content type for this field, if available (for example, image/png for an image file).

Returns:

the content type, or Optional.empty() if not available

getCharset

@Nonnull
public Optional<Charset> getCharset()

The charset used to encode this field, if applicable.

Returns:

the charset, or Optional.empty() if not available

getData

@Nonnull
public Optional<byte[]> getData()

The binary value of this field, if available.

Returns:

the binary value, or Optional.empty() if not available