java.lang.Object
org.refcodes.textual.MessageBuilder
- All Implemented Interfaces:
org.refcodes.mixin.ArgumentsAccessor<Object>
,org.refcodes.mixin.ArgumentsAccessor.ArgumentsBuilder<Object,
,MessageBuilder> org.refcodes.mixin.ArgumentsAccessor.ArgumentsMutator<Object>
,org.refcodes.mixin.ArgumentsAccessor.ArgumentsProperty<Object>
,org.refcodes.mixin.MessageAccessor
,org.refcodes.mixin.MessageAccessor.MessageBuilder<MessageBuilder>
,org.refcodes.mixin.MessageAccessor.MessageMutator
,org.refcodes.mixin.MessageAccessor.MessageProperty
public class MessageBuilder
extends Object
implements org.refcodes.mixin.MessageAccessor.MessageProperty, org.refcodes.mixin.MessageAccessor.MessageBuilder<MessageBuilder>, org.refcodes.mixin.ArgumentsAccessor.ArgumentsProperty<Object>, org.refcodes.mixin.ArgumentsAccessor.ArgumentsBuilder<Object,MessageBuilder>
Wraps
MessageFormat.format(String, Object...)
to prevent failing when
message cannot be formatted. Also expands any arrays passed inside the
arguments to a comma separated String
of the array's elements as of
Arrays.toString(Object[])
without the square braces: In case such an
expanded array's length is 0, then the according placeholder (such as "{0}",
"{1}" and "{2}" and so on) is preserved in the resulting String
!-
Nested Class Summary
Nested classes/interfaces inherited from interface org.refcodes.mixin.ArgumentsAccessor
org.refcodes.mixin.ArgumentsAccessor.ArgumentsBuilder<ARG extends Object,
B extends org.refcodes.mixin.ArgumentsAccessor.ArgumentsBuilder<ARG, B>>, org.refcodes.mixin.ArgumentsAccessor.ArgumentsMutator<ARG extends Object>, org.refcodes.mixin.ArgumentsAccessor.ArgumentsProperty<ARG extends Object> Nested classes/interfaces inherited from interface org.refcodes.mixin.MessageAccessor
org.refcodes.mixin.MessageAccessor.MessageBuilder<B extends org.refcodes.mixin.MessageAccessor.MessageBuilder<B>>, org.refcodes.mixin.MessageAccessor.MessageMutator, org.refcodes.mixin.MessageAccessor.MessageProperty
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic String
WrapsMessageFormat.format(String, Object...)
to prevent failing when message cannot be formatted.Object[]
void
setArguments
(Object[] aArguments) void
setMessage
(String aMessage) WrapsMessageFormat.format(String, Object...)
to prevent failing when message cannot be formatted.toString()
CallstoMessage()
and returns its result.withArguments
(Object[] aArguments) withMessage
(String aMessage) Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.refcodes.mixin.ArgumentsAccessor.ArgumentsProperty
letArguments
Methods inherited from interface org.refcodes.mixin.MessageAccessor.MessageProperty
letMessage
-
Constructor Details
-
MessageBuilder
public MessageBuilder()
-
-
Method Details
-
getMessage
- Specified by:
getMessage
in interfaceorg.refcodes.mixin.MessageAccessor
-
setMessage
- Specified by:
setMessage
in interfaceorg.refcodes.mixin.MessageAccessor.MessageMutator
-
getArguments
- Specified by:
getArguments
in interfaceorg.refcodes.mixin.ArgumentsAccessor<Object>
-
setArguments
- Specified by:
setArguments
in interfaceorg.refcodes.mixin.ArgumentsAccessor.ArgumentsMutator<Object>
-
withArguments
- Specified by:
withArguments
in interfaceorg.refcodes.mixin.ArgumentsAccessor.ArgumentsBuilder<Object,
MessageBuilder>
-
withMessage
- Specified by:
withMessage
in interfaceorg.refcodes.mixin.MessageAccessor.MessageBuilder<MessageBuilder>
-
toMessage
WrapsMessageFormat.format(String, Object...)
to prevent failing when message cannot be formatted. Also expands any arrays passed inside the arguments to a comma separatedString
of the array's elements as ofArrays.toString(Object[])
without the square braces: In case such an expanded array's length is 0, then the according placeholder (such as "{0}", "{1}" and "{2}" and so on) is preserved in the resultingString
!- Returns:
- The substituted message.
-
toString
CallstoMessage()
and returns its result. The accordingString
. -
asMessage
WrapsMessageFormat.format(String, Object...)
to prevent failing when message cannot be formatted. Also expands any arrays passed inside the arguments to a comma separatedString
of the array's elements as ofArrays.toString(Object[])
without the square braces: In case such an expanded array's length is 0, then the according placeholder (such as "{0}", "{1}" and "{2}" and so on) is preserved in the resultingString
!- Parameters:
aMessage
- The message to be formatted by substituting the placeholder ("{0}", "{1}" and "{2}" and so on) with the according arguemtns's elements.aArguments
- the arguments The arguments which are used for substitution.- Returns:
- The substituted message.
-