Buffers (IFS Java Server Framework API documentation (for internal use only))

java.lang.Object
- ifs.fnd.buffer.Buffers

```
public final class Buffers
extends java.lang.Object
```
Utility class with useful operations on Buffers. All methods in this class are static.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`copy(Buffer source, Message dest)` Transform a Buffer into a Message.
`static void`	`copy(Message source, Buffer dest)` Transform a Message into a Buffer.
`static Buffer`	`fromMessage(Message msg)` Transform a Message into a Buffer, using the default implementation of Buffer interface.
`static Buffer`	`getDefaultBuffer()` Return a reference to the default Buffer implementation.
`static BufferFormatter`	`getDefaultFormatter()` Return a reference to the default BufferFormatter.
`static void`	`list(Buffer buf)` Print the contents of the specified Buffer to the Standard Output.
`static void`	`list(Buffer buf, LogOutput out)` Print the contents of the specified Buffer to the specified instance of LogOutput interface.
`static void`	`list(Buffer buf, java.io.OutputStream out)` Print the contents of the specified Buffer to the specified OutputStream.
`static void`	`list(Buffer buf, java.io.PrintWriter out)` Print the contents of the specified Buffer to the specified PrintWriter.
`static java.lang.String`	`listToString(Buffer buf)` Print the contents of the specified Buffer to a string.
`static Buffer`	`load(java.lang.String filename)` Restore the contents of a Buffer from the the specified file, using the default BufferFormatter.
`static boolean`	`loadBoolean(Buffer from, java.lang.String name)` Restore a simple value from a buffer.
`static Buffer`	`loadBuffer(Buffer from, java.lang.String name)` Restore a buffer from another buffer.
`static double`	`loadDouble(Buffer from, java.lang.String name)` Restore a simple value from a buffer.
`static int`	`loadInt(Buffer from, java.lang.String name)` Restore a simple value from a buffer.
`static java.lang.String`	`loadString(Buffer from, java.lang.String name)` Restore a simple value from a buffer.
`static java.lang.String[]`	`loadStringArray(Buffer from, java.lang.String name)` Restore a string array from a buffer.
`static void`	`main(java.lang.String[] arg)` Method used for internal test.
`static void`	`mergeDuplicates(Buffer buf)` Merge nested buffers with the same names.
`static void`	`save(Buffer buffer, java.lang.String filename)` Transform the specified Buffer into a String using the default BufferFormatter and store this String in a file with the specified name.
`static void`	`save(Buffer into, java.lang.String name, boolean value)` Store a name-value pair in a buffer.
`static void`	`save(Buffer into, java.lang.String name, Buffer value)` Store a buffer in another buffer.
`static void`	`save(Buffer into, java.lang.String name, double value)` Store a name-value pair in a buffer.
`static void`	`save(Buffer into, java.lang.String name, int value)` Store a name-value pair in a buffer.
`static void`	`save(Buffer into, java.lang.String name, java.lang.String value)` Store a name-value pair in a buffer.
`static void`	`save(Buffer into, java.lang.String name, java.lang.String[] value)` Store a string array in a buffer.
`static void`	`save(Buffer into, java.lang.String name, java.lang.String[] value, int count)` Store a string array in a buffer.
`static void`	`setDefaultBuffer(Buffer buffer)` Set the default Buffer implementation which will be used by some methods in this class like fromMessage() or load().
`static void`	`setDefaultFormatter(BufferFormatter formatter)` Set the default BufferFormatter which will be used by some methods in this class like save() or load().
`static void`	`sort(Buffer buf, RowComparator comparator)` Sort all rows in a Buffer according to the specified RowComparator.
`static void`	`sortItems(Buffer buf, ItemComparator comparator)` Sort all items in a Buffer according to the specified ItemComparator.
`static Message`	`toMessage(Buffer buffer)` Transform a Buffer into a Message.

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

- Method Detail
  - toMessage
```
public static Message toMessage(Buffer buffer)
                         throws java.lang.Exception
```
    Transform a Buffer into a Message. This operation is unequivocal. Type and Status of each Buffer Item are ignored.
    
    Parameters:
    
    buffer - a buffer to transform
    
    Returns:
    
    a Message corresponding to the specified Buffer
    
    Throws:
    
    java.lang.Exception
  - fromMessage
```
public static Buffer fromMessage(Message msg)
                          throws java.lang.Exception
```
    Transform a Message into a Buffer, using the default implementation of Buffer interface.
    
    Parameters:
    
    msg - a Message to transform
    
    Returns:
    
    a Buffer corresponding to the specified Message
    
    Throws:
    
    java.lang.Exception
  - copy
```
public static void copy(Message source,
                        Buffer dest)
                 throws java.io.IOException
```
    Transform a Message into a Buffer. This operation is ambiguous. An Attribute value that begins with a "!" may be a simple value or a nested Message. This method tries to parse such a value. If this parsing fails or leads to a Message without attributes, then the simple value is assumed; otherwise the nested Message is created. If an Attribute name has the following syntax:
```
    $name[:type][/status]
```
    then the type and/or status are mapped to the type and status of the corresponding Item.
    Parameters:
    
    source - source Message
    
    dest - destination Buffer
    
    Throws:
    
    java.io.IOException
  - copy
```
public static void copy(Buffer source,
                        Message dest)
                 throws java.lang.Exception
```
    Transform a Buffer into a Message. This operation is unequivocal. Type and Status of each Buffer Item are coded using the following syntax:
```
    $name[:type][/status]=value
```
    Parameters:
    
    source - source Buffer
    
    dest - destination Message
    
    Throws:
    
    java.lang.Exception
  - setDefaultFormatter
```
public static void setDefaultFormatter(BufferFormatter formatter)
```
    Set the default BufferFormatter which will be used by some methods in this class like save() or load().
    
    Parameters:
    
    formatter - an instance of BufferFormatter
  - setDefaultBuffer
```
public static void setDefaultBuffer(Buffer buffer)
```
    Set the default Buffer implementation which will be used by some methods in this class like fromMessage() or load().
    
    Parameters:
    
    buffer - an instance of Buffer
  - getDefaultFormatter
```
public static BufferFormatter getDefaultFormatter()
```
    Return a reference to the default BufferFormatter. The formatter is used by some methods in this class like save() or load().
    
    Returns:
    
    an instance of BufferFormatter
  - getDefaultBuffer
```
public static Buffer getDefaultBuffer()
```
    Return a reference to the default Buffer implementation. The method is is used by some methods in this class like fromMessage() or load().
    
    Returns:
    
    a static instance of a Buffer acting as a class template for creation of new Buffer instances
  - save
```
public static void save(Buffer buffer,
                        java.lang.String filename)
                 throws java.io.IOException
```
    Transform the specified Buffer into a String using the default BufferFormatter and store this String in a file with the specified name.
    
    Throws:
    
    java.io.IOException
  - load
```
public static Buffer load(java.lang.String filename)
                   throws java.io.IOException,
                          BufferFormatException
```
    Restore the contents of a Buffer from the the specified file, using the default BufferFormatter.
    
    Throws:
    
    java.io.IOException
    
    BufferFormatException
  - list
```
public static void list(Buffer buf)
                 throws java.io.IOException
```
    Print the contents of the specified Buffer to the Standard Output.
    
    Parameters:
    
    buf - a buffer to list
    
    Throws:
    
    java.io.IOException
  - list
```
public static void list(Buffer buf,
                        java.io.OutputStream out)
                 throws java.io.IOException
```
    Print the contents of the specified Buffer to the specified OutputStream.
    
    Parameters:
    
    buf - a buffer to list
    
    out - an open OutputStream
    
    Throws:
    
    java.io.IOException
  - list
```
public static void list(Buffer buf,
                        java.io.PrintWriter out)
                 throws java.io.IOException
```
    Print the contents of the specified Buffer to the specified PrintWriter.
    
    Parameters:
    
    buf - a buffer to list
    
    out - an open PrintWriter
    
    Throws:
    
    java.io.IOException
  - list
```
public static void list(Buffer buf,
                        LogOutput out)
```
    Print the contents of the specified Buffer to the specified instance of LogOutput interface.
    
    Parameters:
    
    buf - a buffer to list
    
    out - the destination for listing
  - listToString
```
public static java.lang.String listToString(Buffer buf)
```
    Print the contents of the specified Buffer to a string.
    
    Parameters:
    
    buf - a buffer to list
    
    Returns:
    
    string containing the listing of this buffer
  - save
```
public static void save(Buffer into,
                        java.lang.String name,
                        java.lang.String value)
```
    Store a name-value pair in a buffer.
    
    Parameters:
    
    into - destination buffer
    
    name - the name of the item to store
    
    value - simple value to store
  - loadString
```
public static java.lang.String loadString(Buffer from,
                                          java.lang.String name)
```
    Restore a simple value from a buffer.
    
    Parameters:
    
    from - source buffer
    
    name - the name of the item to restore
  - save
```
public static void save(Buffer into,
                        java.lang.String name,
                        int value)
```
    Store a name-value pair in a buffer.
    
    Parameters:
    
    into - destination buffer
    
    name - the name of the item to store
    
    value - simple value to store
  - loadInt
```
public static int loadInt(Buffer from,
                          java.lang.String name)
```
    Restore a simple value from a buffer.
    
    Parameters:
    
    from - source buffer
    
    name - the name of the item to restore
  - save
```
public static void save(Buffer into,
                        java.lang.String name,
                        double value)
```
    Store a name-value pair in a buffer.
    
    Parameters:
    
    into - destination buffer
    
    name - the name of the item to store
    
    value - simple value to store
  - loadDouble
```
public static double loadDouble(Buffer from,
                                java.lang.String name)
```
    Restore a simple value from a buffer.
    
    Parameters:
    
    from - source buffer
    
    name - the name of the item to restore
  - save
```
public static void save(Buffer into,
                        java.lang.String name,
                        boolean value)
```
    Store a name-value pair in a buffer.
    
    Parameters:
    
    into - destination buffer
    
    name - the name of the item to store
  - loadBoolean
```
public static boolean loadBoolean(Buffer from,
                                  java.lang.String name)
```
    Restore a simple value from a buffer.
    
    Parameters:
    
    from - source buffer
    
    name - the name of the item to restore
  - save
```
public static void save(Buffer into,
                        java.lang.String name,
                        Buffer value)
```
    Store a buffer in another buffer.
    
    Parameters:
    
    into - destination buffer
    
    name - the name of the compound item to store
  - loadBuffer
```
public static Buffer loadBuffer(Buffer from,
                                java.lang.String name)
```
    Restore a buffer from another buffer.
    
    Parameters:
    
    from - source buffer
    
    name - the name of the buffer to restore
  - save
```
public static void save(Buffer into,
                        java.lang.String name,
                        java.lang.String[] value)
```
    Store a string array in a buffer.
    
    Parameters:
    
    into - destination buffer
    
    name - the name of the array to store
    
    value - the array to store
  - save
```
public static void save(Buffer into,
                        java.lang.String name,
                        java.lang.String[] value,
                        int count)
```
    Store a string array in a buffer.
    
    Parameters:
    
    into - the destination buffer
    
    name - the name of the array to store
    
    value - the array to store
    
    count - the number array elements to store
  - loadStringArray
```
public static java.lang.String[] loadStringArray(Buffer from,
                                                 java.lang.String name)
```
    Restore a string array from a buffer.
    
    Parameters:
    
    from - the source buffer
    
    name - the name of the array to restore
  - sort
```
public static void sort(Buffer buf,
                        RowComparator comparator)
                 throws java.lang.Exception
```
    Sort all rows in a Buffer according to the specified RowComparator. This method preserves order of rows with equals keys.
    
    Parameters:
    
    buf - a buffer to sort
    
    comparator - a RowComparator to use for comparison of items
    
    Throws:
    
    java.lang.Exception
  - sortItems
```
public static void sortItems(Buffer buf,
                             ItemComparator comparator)
                      throws java.lang.Exception
```
    Sort all items in a Buffer according to the specified ItemComparator.
    
    Parameters:
    
    buf - a buffer to sort
    
    comparator - an ItemComparator to use for comparison of items
    
    Throws:
    
    java.lang.Exception
  - mergeDuplicates
```
public static void mergeDuplicates(Buffer buf)
                            throws FndException
```
    Merge nested buffers with the same names. Throw exception on duplicate of simple items on any level or if a simple item has the same name as a nested buffer.
    
    Parameters:
    
    buf - a buffer to merge duplicates in
    
    Throws:
    
    FndException
  - main
```
public static void main(java.lang.String[] arg)
                 throws java.lang.Exception
```
    Method used for internal test.
    
    Throws:
    
    java.lang.Exception

Class Buffers

Method Summary

Methods inherited from class java.lang.Object

Method Detail

toMessage

fromMessage

copy

copy

setDefaultFormatter

setDefaultBuffer

getDefaultFormatter

getDefaultBuffer

save

load

list

list

list

list

listToString

save

loadString

save

loadInt

save

loadDouble

save

loadBoolean

save

loadBuffer

save

save

loadStringArray

sort

sortItems

mergeDuplicates

main