java.lang.Object
- org.apache.james.mime4j.message.MultipartBuilder

public class MultipartBuilder
extends Object

Multipart builder.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`MultipartBuilder`	`addBinaryPart(byte[] bin, String mimeType)`
`MultipartBuilder`	`addBodyPart(Entity bodyPart)`	Adds a body part to the end of the list of body parts.
`MultipartBuilder`	`addBodyPart(Entity bodyPart, int index)`	Inserts a body part at the specified position in the list of body parts.
`MultipartBuilder`	`addBodyPart(BodyPartBuilder bodyPart)`
`MultipartBuilder`	`addContentTypeParameter(NameValuePair parameter)`
`MultipartBuilder`	`addTextPart(String text, Charset charset)`
`Multipart`	`build()`
`MultipartBuilder`	`copy(Multipart other)`
`static MultipartBuilder`	`create()`
`static MultipartBuilder`	`create(String subType)`
`static MultipartBuilder`	`createCopy(Multipart other)`
`List<Entity>`	`getBodyParts()`	Gets the list of body parts.
`int`	`getCount()`	Returns the number of body parts.
`String`	`getEpilogue()`	Returns epilogue.
`String`	`getPreamble()`	Returns preamble.
`String`	`getSubType()`	Gets the multipart sub-type.
`MultipartBuilder`	`removeBodyPart(int index)`	Removes the body part at the specified position in the list of body parts.
`MultipartBuilder`	`replaceBodyPart(Entity bodyPart, int index)`	Replaces the body part at the specified position in the list of body parts with the specified body part.
`MultipartBuilder`	`setEpilogue(String epilogue)`	Sets the epilogue.
`MultipartBuilder`	`setPreamble(String preamble)`	Sets the preamble.
`MultipartBuilder`	`setSubType(String subType)`	Sets the multipart sub-type.
`MultipartBuilder`	`use(BodyFactory bodyFactory)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - create
```
public static MultipartBuilder create(String subType)
```
  - createCopy
```
public static MultipartBuilder createCopy(Multipart other)
```
  - create
```
public static MultipartBuilder create()
```
  - use
```
public MultipartBuilder use(BodyFactory bodyFactory)
```
  - getSubType
```
public String getSubType()
```
    Gets the multipart sub-type. E.g. alternative (the default) or parallel. See RFC 2045 for common sub-types and their meaning.
    
    Returns:
    
    the multipart sub-type.
  - setSubType
```
public MultipartBuilder setSubType(String subType)
```
    Sets the multipart sub-type. E.g. alternative or parallel. See RFC 2045 for common sub-types and their meaning.
    
    Parameters:
    
    subType - the sub-type.
  - getCount
```
public int getCount()
```
    Returns the number of body parts.
    
    Returns:
    
    number of Entity objects.
  - getBodyParts
```
public List<Entity> getBodyParts()
```
    Gets the list of body parts. The list is immutable.
    
    Returns:
    
    the list of Entity objects.
  - addBodyPart
```
public MultipartBuilder addBodyPart(Entity bodyPart)
```
    Adds a body part to the end of the list of body parts.
    
    Parameters:
    
    bodyPart - the body part.
  - addBodyPart
```
public MultipartBuilder addBodyPart(BodyPartBuilder bodyPart)
```
  - addBodyPart
```
public MultipartBuilder addBodyPart(Entity bodyPart,
                                    int index)
```
    Inserts a body part at the specified position in the list of body parts.
    
    Parameters:
    
    bodyPart - the body part.
    
    index - index at which the specified body part is to be inserted.
  - removeBodyPart
```
public MultipartBuilder removeBodyPart(int index)
```
    Removes the body part at the specified position in the list of body parts.
    
    Parameters:
    
    index - index of the body part to be removed.
    
    Returns:
    
    the removed body part.
  - replaceBodyPart
```
public MultipartBuilder replaceBodyPart(Entity bodyPart,
                                        int index)
```
    Replaces the body part at the specified position in the list of body parts with the specified body part.
    
    Parameters:
    
    bodyPart - body part to be stored at the specified position.
    
    index - index of body part to replace.
    
    Returns:
    
    the replaced body part.
    
    Throws:
    
    IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= getCount()).
  - getPreamble
```
public String getPreamble()
```
    Returns preamble.
    
    Returns:
    
    the preamble.
  - setPreamble
```
public MultipartBuilder setPreamble(String preamble)
```
    Sets the preamble.
    
    Parameters:
    
    preamble - the preamble.
  - getEpilogue
```
public String getEpilogue()
```
    Returns epilogue.
    
    Returns:
    
    the epilogue.
  - setEpilogue
```
public MultipartBuilder setEpilogue(String epilogue)
```
    Sets the epilogue.
    
    Parameters:
    
    epilogue - the epilogue.
  - addContentTypeParameter
```
public MultipartBuilder addContentTypeParameter(NameValuePair parameter)
```
  - addTextPart
```
public MultipartBuilder addTextPart(String text,
                                    Charset charset)
                             throws IOException
```
    Throws:
    
    IOException
  - addBinaryPart
```
public MultipartBuilder addBinaryPart(byte[] bin,
                                      String mimeType)
                               throws IOException
```
    Throws:
    
    IOException
  - copy
```
public MultipartBuilder copy(Multipart other)
```
  - build
```
public Multipart build()
```

Class MultipartBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

createCopy

create

use

getSubType

setSubType

getCount

getBodyParts

addBodyPart

addBodyPart

addBodyPart

removeBodyPart

replaceBodyPart

getPreamble

setPreamble

getEpilogue

setEpilogue

addContentTypeParameter

addTextPart

addBinaryPart

copy

build