ReplyBuilder (Votorola Java API)

java.lang.Object
- BundleFormatter
- - ReplyBuilder

All Implemented Interfaces:

Appendable
```
@ThreadRestricted
public final class ReplyBuilder
extends BundleFormatter
implements Appendable
```
A composite resource bundle, string formatter and character buffer. It builds a plain-text, line-wrapped, message.

Nested Class Summary
- Nested classes/interfaces inherited from class BundleFormatter
  BundleFormatter.GProvider

Field Summary

Fields
Modifier and Type Field and Description

static int WRAPPED_WIDTH
Maximum width of wrapped text, in 'columns'.
- Fields inherited from class BundleFormatter
  ASSUMED_PACKAGE_PREFIX, bundle, formatter

Fields
Modifier and Type	Field and Description
`static int`	`WRAPPED_WIDTH` Maximum width of wrapped text, in 'columns'.

Constructor Summary

Constructors
Constructor and Description
`ReplyBuilder(Locale l)` Constructs a command/response (CR) ReplyBuilder, for building a reply to a command.
`ReplyBuilder(ResourceBundle bundle)` Constructs a ReplyBuilder.

Method Summary

Methods
Modifier and Type	Method and Description
`ReplyBuilder`	`append(char c)` Appends the specified character to the buffer.
`ReplyBuilder`	`append(CharSequence csq)` Appends the specified character sequence to the buffer.
`ReplyBuilder`	`append(CharSequence csq, int start, int end)` Appends a subsequence of the specified character sequence to the buffer.
`ReplyBuilder`	`append(int i)` Appends the string representation of the specified integer to the buffer.
`ReplyBuilder`	`append(long l)` Appends the string representation of the specified long integer to the buffer.
`ReplyBuilder`	`appendln()` Appends a newline.
`ReplyBuilder`	`appendln(char c)` Appends the specified character, plus a newline, to the buffer.
`ReplyBuilder`	`appendln(CharSequence csq)` Appends the specified character sequence, plus a newline, to the buffer.
`ReplyBuilder`	`appendlnn()` Appends a double newline.
`ReplyBuilder`	`appendlnn(CharSequence csq)` Appends the specified character sequence, plus a double newline, to the buffer.
`ReplyBuilder`	`appendRepeat(char c, int n)` Appends n copies of character c to the buffer.
`ReplyBuilder`	`appendRepeatln(char c, int n)` Appends n copies of character c, plus a newline, to the buffer.
`ReplyBuilder`	`appendRepeatlnn(char c, int n)` Appends n copies of character c, plus a double newline, to the buffer.
`ReplyBuilder`	`chomplnn()` Chops any trailing double newline down to a single newline.
`ReplyBuilder`	`exdent(int amount)` Decreases the left wrap-margin, undoing a previous indent.
`ReplyBuilder`	`indent(int amount)` Appends some spaces, and increases the left wrap-margin accordingly.
`boolean`	`isWrapping()` Returns true if wrapping is enabled; false otherwise.
`ReplyBuilder`	`lappend(String key, Object... args)` Appends a localized string to the buffer.
`ReplyBuilder`	`lappendln(String key, Object... args)` Appends a localized string, plus a newline, to the buffer.
`ReplyBuilder`	`lappendlnn(String key, Object... args)` Appends a localized string, plus a double newline, to the buffer.
`int`	`length()` Returns the current length (character count) of the buffer.
`ReplyBuilder`	`resetFormattingToDefaults()` Set indentation and wrapping to defaults.
`ReplyBuilder`	`setWrapping(boolean toWrap)` Sets whether wrapping is enabled.
`String`	`toString()` Returns the reply as constructed in the buffer, to this point.

Methods inherited from class BundleFormatter
bundle, format, l, locale, stringBuilder

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

- Field Detail
  - WRAPPED_WIDTH
```
public static final int WRAPPED_WIDTH
```
    Maximum width of wrapped text, in 'columns'.
    
    See Also:
    isWrapping, Constant Field Values
- Constructor Detail
  - ReplyBuilder
```
public ReplyBuilder(ResourceBundle bundle)
```
    Constructs a ReplyBuilder.
    
    Parameters:
    bundle - the resource bundle to use, per bundle()
  - ReplyBuilder
```
public ReplyBuilder(Locale l)
```
    Constructs a command/response (CR) ReplyBuilder, for building a reply to a command. It uses bundle base name 'votorola.a.locale.CR'.
    
    Parameters:
    l - locale, per locale()
    See Also:
    locale/CR.properties
- Method Detail
  - append
```
public ReplyBuilder append(int i)
```
    Appends the string representation of the specified integer to the buffer.
  - append
```
public ReplyBuilder append(long l)
```
    Appends the string representation of the specified long integer to the buffer.
  - appendln
```
public ReplyBuilder appendln()
```
    Appends a newline.
  - appendlnn
```
public ReplyBuilder appendlnn()
```
    Appends a double newline.
  - appendRepeat
```
public ReplyBuilder appendRepeat(char c,
                        int n)
```
    Appends n copies of character c to the buffer.
  - appendRepeatln
```
public ReplyBuilder appendRepeatln(char c,
                          int n)
```
    Appends n copies of character c, plus a newline, to the buffer.
  - appendRepeatlnn
```
public ReplyBuilder appendRepeatlnn(char c,
                           int n)
```
    Appends n copies of character c, plus a double newline, to the buffer.
  - chomplnn
```
public ReplyBuilder chomplnn()
```
    Chops any trailing double newline down to a single newline. Useful prior to calling toString().
  - exdent
```
public ReplyBuilder exdent(int amount)
```
    Decreases the left wrap-margin, undoing a previous indent.
    
    See Also:
    indent(int)
  - indent
```
public ReplyBuilder indent(int amount)
```
    Appends some spaces, and increases the left wrap-margin accordingly.
    
    See Also:
    exdent(int)
  - isWrapping
```
public final boolean isWrapping()
```
    Returns true if wrapping is enabled; false otherwise. When enabled, lines longer than WRAPPED_WIDTH will automatically wrap back to the left margin. By default, it is enabled.
    
    See Also:
    setWrapping(boolean)
  - setWrapping
```
public final ReplyBuilder setWrapping(boolean toWrap)
```
    Sets whether wrapping is enabled.
    
    See Also:
    isWrapping
  - lappend
```
public ReplyBuilder lappend(String key,
                   Object... args)
```
    Description copied from class: BundleFormatter
    
    Appends a localized string to the buffer.
    
    Overrides:
    
    lappend in class BundleFormatter
    
    Parameters:
    key - bundle key of the string
    args - arguments for insertion in the string, per format(string,args)
  - lappendln
```
public ReplyBuilder lappendln(String key,
                     Object... args)
```
    Appends a localized string, plus a newline, to the buffer.
    
    Parameters:
    key - bundle key of the string
    args - arguments for insertion in the string, per format(String,Object[])
  - lappendlnn
```
public ReplyBuilder lappendlnn(String key,
                      Object... args)
```
    Appends a localized string, plus a double newline, to the buffer.
    
    Parameters:
    key - bundle key of the string
    args - arguments for insertion in the string, per format(String,Object[])
  - length
```
public int length()
```
    Returns the current length (character count) of the buffer.
  - resetFormattingToDefaults
```
public final ReplyBuilder resetFormattingToDefaults()
```
    Set indentation and wrapping to defaults.
    
    See Also:
    indent(int), isWrapping
  - append
```
public ReplyBuilder append(char c)
```
    Appends the specified character to the buffer.
    
    Specified by:
    
    append in interface Appendable
  - appendln
```
public ReplyBuilder appendln(char c)
```
    Appends the specified character, plus a newline, to the buffer.
  - append
```
public ReplyBuilder append(CharSequence csq)
```
    Appends the specified character sequence to the buffer.
    
    Specified by:
    
    append in interface Appendable
  - appendln
```
public ReplyBuilder appendln(CharSequence csq)
```
    Appends the specified character sequence, plus a newline, to the buffer.
  - appendlnn
```
public ReplyBuilder appendlnn(CharSequence csq)
```
    Appends the specified character sequence, plus a double newline, to the buffer.
  - append
```
public ReplyBuilder append(CharSequence csq,
                  int start,
                  int end)
```
    Appends a subsequence of the specified character sequence to the buffer.
    
    Specified by:
    
    append in interface Appendable
  - toString
```
public String toString()
```
    Returns the reply as constructed in the buffer, to this point.
    
    Overrides:
    
    toString in class Object
    
    See Also:
    chomplnn()

Class ReplyBuilder

Nested Class Summary

Nested classes/interfaces inherited from class BundleFormatter

Field Summary

Fields inherited from class BundleFormatter

Constructor Summary

Method Summary

Methods inherited from class BundleFormatter

Methods inherited from class java.lang.Object

Field Detail

WRAPPED_WIDTH

Constructor Detail

ReplyBuilder

ReplyBuilder

Method Detail

append

append

appendln

appendlnn

appendRepeat

appendRepeatln

appendRepeatlnn

chomplnn

exdent

indent

isWrapping

setWrapping

lappend

lappendln

lappendlnn

length

resetFormattingToDefaults

append

appendln

append

appendln

appendlnn

append

toString