Package org.jboss.resteasy.plugins.providers.multipart

Class ResteasyEntityPartBuilder

java.lang.Object

org.jboss.resteasy.plugins.providers.multipart.ResteasyEntityPartBuilder

All Implemented Interfaces:

EntityPart.Builder

public class ResteasyEntityPartBuilder
extends Object
implements EntityPart.Builder

An implementation of the EntityPart.Builder.

This is not intended for direct usage. Use the EntityPart.withName(String) instead.

Author:

James R. Perkins

Constructor Summary

Constructors

Constructor	Description
ResteasyEntityPartBuilder(String name)	Creates a new builder with the part name.

Method Summary

Modifier and Type	Method	Description
EntityPart	build()	Builds a new EntityPart instance using the provided property values.
EntityPart.Builder	content(InputStream content)	Sets the content for this part.
EntityPart.Builder	content(Object content)	Sets the content for this part.
<T> EntityPart.Builder	content(T content, GenericType<T> type)	Sets the content for this part.
<T> EntityPart.Builder	content(T content, Class<? extends T> type)	Sets the content for this part.
EntityPart.Builder	fileName(String fileName)	Sets the file name for this part.
EntityPart.Builder	header(String headerName, String... headerValues)	Adds a new header or replaces a previously added header and sets the header value(s).
EntityPart.Builder	headers(MultivaluedMap<String,String> newHeaders)	Adds new headers or replaces previously added headers.
EntityPart.Builder	mediaType(MediaType mediaType)	Sets the media type for the EntityPart.
EntityPart.Builder	mediaType(String mediaTypeString)	Convenience method for setting the media type for the EntityPart.

Methods inherited from class java.lang.Object

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

Methods inherited from interface jakarta.ws.rs.core.EntityPart.Builder

content

Constructor Detail

ResteasyEntityPartBuilder

public ResteasyEntityPartBuilder(String name)

Creates a new builder with the part name.

Parameters:

name - the part name

Method Detail

mediaType

public EntityPart.Builder mediaType(MediaType mediaType)
                             throws IllegalArgumentException

Description copied from interface: EntityPart.Builder

Sets the media type for the EntityPart. This will also set the Content-Type header for this part.

Specified by:

mediaType in interface EntityPart.Builder

Parameters:

mediaType - the media type for the part to be built

Returns:

the updated builder

Throws:

IllegalArgumentException - if mediaType is null

mediaType

public EntityPart.Builder mediaType(String mediaTypeString)
                             throws IllegalArgumentException

Description copied from interface: EntityPart.Builder

Convenience method for setting the media type for the EntityPart. This will also set the Content-Type header for this part. This call is effectively the same as mediaType(MediaType.valueOf(mediaTypeString)).

Specified by:

mediaType in interface EntityPart.Builder

Parameters:

mediaTypeString - the media type for the part to be built

Returns:

the updated builder

Throws:

IllegalArgumentException - if mediaTypeString cannot be parsed or is null

header

public EntityPart.Builder header(String headerName,
                                 String... headerValues)
                          throws IllegalArgumentException

Description copied from interface: EntityPart.Builder

Adds a new header or replaces a previously added header and sets the header value(s).

Specified by:

header in interface EntityPart.Builder

Parameters:

headerName - the header name

headerValues - the header value(s)

Returns:

the updated builder

Throws:

IllegalArgumentException - if headerName is null

headers

public EntityPart.Builder headers(MultivaluedMap<String,String> newHeaders)
                           throws IllegalArgumentException

Description copied from interface: EntityPart.Builder

Adds new headers or replaces previously added headers. The behavior of this method would be the same as if iterating over the entry set and invoking the EntityPart.Builder.header(String, String...) method.

Specified by:

headers in interface EntityPart.Builder

Parameters:

newHeaders - the multivalued map of headers to add to this part

Returns:

the updated builder

Throws:

IllegalArgumentException - if newHeaders is null

fileName

public EntityPart.Builder fileName(String fileName)
                            throws IllegalArgumentException

Description copied from interface: EntityPart.Builder

Sets the file name for this part. The file name will be specified as an attribute in the Content-Disposition header of this part. When this method is called, the default media type used for the built part will be "application/octet-stream" if not otherwise specified.

Specified by:

fileName in interface EntityPart.Builder

Parameters:

fileName - the file name for this part

Returns:

the updated builder

Throws:

IllegalArgumentException - if fileName is null

content

public EntityPart.Builder content(InputStream content)
                           throws IllegalArgumentException

Description copied from interface: EntityPart.Builder

Sets the content for this part. The content of this builder must be specified before invoking the EntityPart.Builder.build() method.

The InputStream will be closed by the implementation code after sending the multipart data. Closing the stream before it is sent could result in unexpected behavior.

Specified by:

content in interface EntityPart.Builder

Parameters:

content - InputStream of the content of this part

Returns:

the updated builder

Throws:

IllegalArgumentException - if content is null

content

public <T> EntityPart.Builder content(T content,
                                      Class<? extends T> type)
                               throws IllegalArgumentException

Description copied from interface: EntityPart.Builder

Sets the content for this part. The content of this builder must be specified before invoking the EntityPart.Builder.build() method.

If the content is specified using this method, then the EntityPart.Builder.build() method is responsible for finding a registered MessageBodyWriter that is capable of writing the object type specified here using the default MediaType or the MediaType specified in the EntityPart.Builder.mediaType(MediaType) or EntityPart.Builder.mediaType(String) methods and using any headers specified via the EntityPart.Builder.header(String, String...) or EntityPart.Builder.headers(MultivaluedMap) methods.

Specified by:

content in interface EntityPart.Builder

Type Parameters:

T - the entity type

Parameters:

content - the object to be used as the content

type - the type of this object which will be used when selecting the appropriate MessageBodyWriter

Returns:

the updated builder.

Throws:

IllegalArgumentException - if content is null

content

public EntityPart.Builder content(Object content)
                           throws IllegalArgumentException

Description copied from interface: EntityPart.Builder

Sets the content for this part. The content of this builder must be specified before invoking the EntityPart.Builder.build() method.

If the content is specified using this method, then the EntityPart.Builder.build() method is responsible for finding a registered MessageBodyWriter that is capable of writing the object's class type specified here using the default MediaType or the MediaType specified in the EntityPart.Builder.mediaType(MediaType) or EntityPart.Builder.mediaType(String) methods and using any headers specified via the EntityPart.Builder.header(String, String...) or EntityPart.Builder.headers(MultivaluedMap) methods.

This is the equivalent of calling content(content, content.getClass()).

Specified by:

content in interface EntityPart.Builder

Parameters:

content - the object to be used as the content

Returns:

the updated builder.

Throws:

IllegalArgumentException - if content is null

content

public <T> EntityPart.Builder content(T content,
                                      GenericType<T> type)
                               throws IllegalArgumentException

Description copied from interface: EntityPart.Builder

Sets the content for this part. The content of this builder must be specified before invoking the EntityPart.Builder.build() method.

If the content is specified using this method, then the EntityPart.Builder.build() method is responsible for finding a registered MessageBodyWriter that is capable of writing the object type specified here using the default MediaType or the MediaType specified in the EntityPart.Builder.mediaType(MediaType) or EntityPart.Builder.mediaType(String) methods and using any headers specified via the EntityPart.Builder.header(String, String...) or EntityPart.Builder.headers(MultivaluedMap) methods.

Specified by:

content in interface EntityPart.Builder

Type Parameters:

T - the entity type

Parameters:

content - the object to be used as the content

type - the generic type of this object which will be used when selecting the appropriate MessageBodyWriter

Returns:

the updated builder.

Throws:

IllegalArgumentException - if content is null

build

public EntityPart build()
                 throws IllegalStateException,
                        IOException,
                        WebApplicationException

Description copied from interface: EntityPart.Builder

Builds a new EntityPart instance using the provided property values.

Specified by:

build in interface EntityPart.Builder

Returns:

EntityPart instance built from the provided property values.

Throws:

IllegalStateException - if the content was not specified or no matching MessageBodyWriter was found.

IOException - if the underlying MessageBodyWriter throws an IOException

WebApplicationException - if the underlying MessageBodyWriter throws a WebApplicationException