Multipart (Stringflow Java SDK 2.0.0 API)

java.lang.Object
- abs.ixi.client.io.multipart.Multipart

All Implemented Interfaces:

Writable
```
public class Multipart
extends Object
implements Writable
```
A MultipartMessage can have multiple parts within it; each of these parts is represented by Multipart. A Multipart contains headers and body. Headers are stored in a Map and miltipart body is held in a Content

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CONTENT_LENGTH`
`static String`	`CONTENT_TYPE`
`static byte`	`CR`
`static byte`	`LF`
`static ByteBuffer`	`LINE_FEED_BUFFER`
`protected static byte[]`	`LINE_FEED_BYTES`
`static String`	`NAME`

Constructor Summary

Constructors
Constructor and Description
`Multipart()`
`Multipart(Map<String,String> headers, byte[] content)`
`Multipart(String name)`
`Multipart(String name, Content content)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addHeader(String key, String value)`
`void`	`addHeaders(Map<String,String> headers)`
`protected byte[]`	`generateHeaderBytes()` Append headers to a String and generate bytes using `StandardCharsets.US_ASCII` encoding.
`Content`	`getContent()`
`int`	`getContentLength()`
`ContentSource`	`getContentSource()`
`String`	`getContentType()`
`String`	`getHeader(String key)`
`byte[]`	`getHeaderBytes()`
`Map<String,String>`	`getHeaders()`
`long`	`getMultipartLength()` Calculate the length of this multipart object.
`String`	`getName()`
`void`	`setContent(Content content)`
`long`	`writeTo(OutputStream os)` Write to an `OutputStream`
`long`	`writeTo(Socket socket)` Write this entity to a network socket.
`long`	`writeTo(SocketChannel socketChannel)` Write this entity to a `SocketChannel`

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

- Field Detail
  - LF
```
public static final byte LF
```
    See Also:
    
    Constant Field Values
  - CR
```
public static final byte CR
```
    See Also:
    
    Constant Field Values
  - NAME
```
public static final String NAME
```
    See Also:
    
    Constant Field Values
  - CONTENT_TYPE
```
public static final String CONTENT_TYPE
```
    See Also:
    
    Constant Field Values
  - CONTENT_LENGTH
```
public static final String CONTENT_LENGTH
```
    See Also:
    
    Constant Field Values
  - LINE_FEED_BYTES
```
protected static final byte[] LINE_FEED_BYTES
```
  - LINE_FEED_BUFFER
```
public static final ByteBuffer LINE_FEED_BUFFER
```
- Constructor Detail
  - Multipart
```
public Multipart()
```
  - Multipart
```
public Multipart(String name)
```
  - Multipart
```
public Multipart(String name,
                 Content content)
```
  - Multipart
```
public Multipart(Map<String,String> headers,
                 byte[] content)
```
- Method Detail
  - getContent
```
public Content getContent()
```
  - setContent
```
public void setContent(Content content)
```
  - getContentSource
```
public ContentSource getContentSource()
```
  - addHeader
```
public void addHeader(String key,
                      String value)
```
  - addHeaders
```
public void addHeaders(Map<String,String> headers)
```
  - getHeader
```
public String getHeader(String key)
```
  - getHeaders
```
public Map<String,String> getHeaders()
```
  - getContentLength
```
public int getContentLength()
```
  - getName
```
public String getName()
```
  - generateHeaderBytes
```
protected byte[] generateHeaderBytes()
```
    Append headers to a String and generate bytes using StandardCharsets.US_ASCII encoding.
    
    Returns:
    
    byte byte array
  - getHeaderBytes
```
public byte[] getHeaderBytes()
```
  - getContentType
```
public String getContentType()
```
    Returns:
    
    value of Content-Type header for this Multipart
  - getMultipartLength
```
public long getMultipartLength()
```
    Calculate the length of this multipart object. Length is the number of bytes required to represent this Multipart in memeory. Returned length includes both header bytes along with body content bytes.
    
    Returns:
    
    long long
  - writeTo
```
public long writeTo(Socket socket)
             throws IOException
```
    Description copied from interface: Writable
    
    Write this entity to a network socket. The byte conversion mechanism is up to the implementation to decide.
    
    Specified by:
    
    writeTo in interface Writable
    
    Parameters:
    
    socket - network socket on which bytes will be written
    
    Returns:
    
    no of bytes written
    
    Throws:
    
    IOException - if any IO error occurred
  - writeTo
```
public long writeTo(OutputStream os)
             throws IOException
```
    Description copied from interface: Writable
    
    Write to an OutputStream
    
    Specified by:
    
    writeTo in interface Writable
    
    Parameters:
    
    os - OutputStream insatnce
    
    Returns:
    
    no of bytes written
    
    Throws:
    
    IOException - if IO error occurrs
  - writeTo
```
public long writeTo(SocketChannel socketChannel)
             throws IOException
```
    Description copied from interface: Writable
    
    Write this entity to a SocketChannel
    
    Specified by:
    
    writeTo in interface Writable
    
    Parameters:
    
    socketChannel - network socket channel
    
    Returns:
    
    no of bytes written
    
    Throws:
    
    IOException - if any IO error occurred while writing bytes

Class Multipart

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LF

CR

NAME

CONTENT_TYPE

CONTENT_LENGTH

LINE_FEED_BYTES

LINE_FEED_BUFFER

Constructor Detail

Multipart

Multipart

Multipart

Multipart

Method Detail

getContent

setContent

getContentSource

addHeader

addHeaders

getHeader

getHeaders

getContentLength

getName

generateHeaderBytes

getHeaderBytes

getContentType

getMultipartLength

writeTo

writeTo

writeTo