public class BrokerCompleteCollection
extends java.lang.Object
Note that several of the objects in this collection are also container objects. Including an object in one of them can result in that object being placed in an export file or used during an import as well.
Modifier and Type | Field and Description |
---|---|
BrokerAccessControlList[] |
acls |
BrokerCompleteBroker[] |
brokers |
BrokerCompleteClientGroup[] |
client_groups |
BrokerCompleteClient[] |
clients |
BrokerCompleteEventType[] |
event_types |
BrokerCompleteServer[] |
servers |
Constructor and Description |
---|
BrokerCompleteCollection()
Constructor.
|
Modifier and Type | Method and Description |
---|---|
static BrokerCompleteCollection |
read(java.io.Reader reader)
Creates a new BrokerCompleteCollection based upon textual input.
|
static BrokerCompleteCollection |
readFile(java.lang.String filename)
Creates a new BrokerCompleteCollection based upon textual input read from a file.
|
java.lang.String |
toString()
Converts this object's information into a string.
|
java.lang.String |
toString(int indent_level)
Converts this object's information into a string.
|
void |
write(java.io.Writer writer,
int indent_level)
Writes this object's information out in a textual format.
|
void |
write(java.io.Writer writer,
int indent_level,
boolean escape_unicode)
Writes this object's information out in a textual format.
|
static void |
writeVersionNumber(java.io.Writer writer,
int indent_level)
Writes a version number string.
|
public BrokerCompleteServer[] servers
public BrokerCompleteBroker[] brokers
public BrokerCompleteClient[] clients
public BrokerCompleteClientGroup[] client_groups
public BrokerCompleteEventType[] event_types
public BrokerAccessControlList[] acls
public static BrokerCompleteCollection read(java.io.Reader reader) throws BrokerException, java.io.IOException
Because the the reader can only be read from once, this method does not handle the old export file formats like readFile can.
For best efficiency, do not pass in a BufferedReader, because the underlying parser already performs read buffering.
java.io.IOException
- If there is an error reading.BrokerInputParseException
- If there is a parse error in the text.BrokerNullParameterException
- If reader is null.BrokerException
public static BrokerCompleteCollection readFile(java.lang.String filename) throws BrokerException, java.io.IOException
If the file does not use the most current file format, an attempt will be made to re-read the file using the old file format (from previous releases.) A BrokerInputParseException thrown when reading from a file using an old format does not provide the line number when there is an error.
java.io.IOException
- If there is an error reading.BrokerInputParseException
- If there is a parse error in the text.BrokerNullParameterException
- If filename is null.BrokerException
public static void writeVersionNumber(java.io.Writer writer, int indent_level) throws BrokerException, java.io.IOException
This method is separated from the write functions so you may control which parts of a collection are written to the file and write the version number of the file format only once, at the top.
java.io.IOException
- If there is an error writing.BrokerNullParameterException
- If writer is null.BrokerOutOfRangeException
- If indent_level is less than 0.BrokerException
public void write(java.io.Writer writer, int indent_level, boolean escape_unicode) throws BrokerException, java.io.IOException
Unicode characters in the output are escaped using backslash-u notiation (e.g. ?) if the escape_unicode arguement is true. Set the escape_unicode arguement to false only if you desire native format unicode characters that can be more easily edited in locale editors. Unescaped unicode characters cannot be read again on every platform and locale.
Does not write anything if all of the data members are null, or if all of them return empty strings when converted to strings.
You may call this function repeatedly with the same writer to write multiple collections into the same file.
Does not write the export file format version number to the file. Use writeVersionNumber once at the beginning of the file to do that.
java.io.IOException
- If there is an error writing to the file.BrokerNullParameterException
- If writer is null.BrokerOutOfRangeException
- If indent_level is less than 0.BrokerException
public void write(java.io.Writer writer, int indent_level) throws BrokerException, java.io.IOException
Unicode characters in the output are escaped using backslash-u notiation (e.g. ?).
Does not write anything if all of the data members are null, or if all of them return empty strings when converted to strings.
You may call this function repeatedly with the same writer to write multiple collections into the same file.
Does not write the export file format version number to the file. Use writeVersionNumber once at the beginning of the file to do that.
java.io.IOException
- If there is an error writing to the file.BrokerNullParameterException
- If writer is null.BrokerOutOfRangeException
- If indent_level is less than 0.BrokerException
public java.lang.String toString(int indent_level) throws BrokerException
Unicode characters in the output are escaped using backslash-u notiation (e.g. ?).
Returns an empty string if all of the data members are null, or if all of them return empty strings when converted to strings.
BrokerOutOfRangeException
- If indent_level is less than 0.BrokerException
public java.lang.String toString()
Unicode characters in the output are escaped using backslash-u notiation (e.g. ?).
Returns an empty string if all of the data members are null, or if all of them return empty strings when converted to strings.
toString
in class java.lang.Object
Copyright © 2002-2006 webMethods, Inc. Copyright © 2007-2021 Software AG Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.