ComposableBody.Builder (JBOSH 0.8.0 API)

Skip navigation links

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.igniterealtime.jbosh.ComposableBody.Builder

Enclosing class:

ComposableBody
```
public static final class ComposableBody.Builder
extends Object
```
Class instance builder, after the builder pattern. This allows each message instance to be immutable while providing flexibility when building new messages.
Instances of this class are not thread-safe.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ComposableBody`	`build()` Build the immutable object instance with the current configuration.
`ComposableBody.Builder`	`setAttribute(BodyQName name, String value)` Set an attribute on the message body / wrapper element.
`ComposableBody.Builder`	`setNamespaceDefinition(String prefix, String uri)` Convenience method to set a namespace definition.
`ComposableBody.Builder`	`setPayloadXML(String xml)` Set the body message's wrapped payload content.

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

- Method Detail
  - setPayloadXML
```
public ComposableBody.Builder setPayloadXML(String xml)
```
    Set the body message's wrapped payload content. Any previous content will be replaced.
    
    Parameters:
    
    xml - payload XML content
    
    Returns:
    
    builder instance
  - setAttribute
```
public ComposableBody.Builder setAttribute(BodyQName name,
                                           String value)
```
    Set an attribute on the message body / wrapper element.
    
    Parameters:
    
    name - qualified name of the attribute
    
    value - value of the attribute
    
    Returns:
    
    builder instance
  - setNamespaceDefinition
```
public ComposableBody.Builder setNamespaceDefinition(String prefix,
                                                     String uri)
```
    Convenience method to set a namespace definition. This would result in a namespace prefix definition similar to: <body xmlns:prefix="uri"/>
    
    Parameters:
    
    prefix - prefix to define
    
    uri - namespace URI to associate with the prefix
    
    Returns:
    
    builder instance
  - build
```
public ComposableBody build()
```
    Build the immutable object instance with the current configuration.
    
    Returns:
    
    composable body instance

Skip navigation links

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2015. All rights reserved.