|
Errai 3.0.1-SNAPSHOT | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface MessageBuildParms<R>
A template for building the different parameters of a message. This ensures that they are constructed properly.
Part of the fluent API centered around MessageBuilder
.
Method Summary | |
---|---|
MessageBuildParms<R> |
copy(Enum<?> part,
Message m)
Copies a message part to the specified message, replacing that part in the target message if it already exists. |
MessageBuildParms<R> |
copy(String part,
Message m)
Copies the message part to the specified message |
MessageBuildParms<R> |
copyResource(String part,
Message m)
Copies a message resource to the specified message, replacing that resource in the target message if it already exists. |
R |
defaultErrorHandling()
Specifies that the default error handler should be notified when there are errors in transmitting this builder's message (see DefaultErrorCallback ). |
R |
done()
No-op method for returning the underlying message being built. |
R |
errorsHandledBy(ErrorCallback callback)
Sets the error callback function for the message. |
MessageBuildParms<R> |
flag(RoutingFlag flag)
Sets a RoutingFlag on the underlying message. |
R |
noErrorHandling()
Specifies that any errors encountered while handling or transmitting this builder's message should be silently ignored. |
MessageBuildParms<R> |
with(Enum<?> part,
Object value)
Sets the message part to the specified value, replacing any old value associated with that part. |
MessageBuildParms<R> |
with(String part,
Object value)
Sets the message part to the specified value, replacing any old value associated with that part. |
MessageBuildParms<R> |
withProvided(Enum<?> part,
ResourceProvider<?> provider)
Sets the message part to be generated at message transmission time by the given provider, replacing any old value associated with that part. |
MessageBuildParms<R> |
withProvided(String part,
ResourceProvider<?> provider)
Sets the message part to be generated at message transmission time by the given provider, replacing any old value associated with that part. |
MessageBuildParms<R> |
withValue(Object value)
Include a default value with the message. |
Methods inherited from interface org.jboss.errai.bus.client.api.builder.MessageBuild |
---|
getMessage |
Method Detail |
---|
MessageBuildParms<R> withValue(Object value)
value
-
MessageBuildParms
for chaining additional callsMessageBuildParms<R> with(String part, Object value)
part
- the message part to add or replacevalue
- the value of the message part
MessageBuildParms
for chaining additional callsMessageBuildParms<R> flag(RoutingFlag flag)
RoutingFlag
on the underlying message.
flag
- the RoutingFlag
to set
MessageBuildParms
for chaining additional callsMessageBuildParms<R> with(Enum<?> part, Object value)
part
- the message part to add or replacevalue
- the value of the message part
MessageBuildParms
for chaining additional callsMessageBuildParms<R> withProvided(String part, ResourceProvider<?> provider)
part
- the message part to add or replaceprovider
- the provider that generates the value for this message part each time the message is transmitted.
MessageBuildParms
for chaining additional callsMessageBuildParms<R> withProvided(Enum<?> part, ResourceProvider<?> provider)
part
- the message part to add or replaceprovider
- the provider that generates the value for this message part each time the message is transmitted.
MessageBuildParms
for chaining additional callsMessageBuildParms<R> copy(String part, Message m)
part
- the message partm
- the target message to receive the copied part.
MessageBuildParms
for chaining additional callsMessageBuildParms<R> copy(Enum<?> part, Message m)
part
- the message part to copy from this builder's message.m
- the target message to receive the copied part.
MessageBuildParms
for chaining additional callsMessageBuildParms<R> copyResource(String part, Message m)
part
- the message resource to copy from this builder's message.m
- the target message to receive the copied resource.
MessageBuildParms
for chaining additional callsR errorsHandledBy(ErrorCallback callback)
callback
- the function to be called when an error occurs.
R noErrorHandling()
R defaultErrorHandling()
DefaultErrorCallback
).
R done()
|
Errai 3.0.1-SNAPSHOT | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |