vqServer API Class vq.utils.vqos

java.lang.Object
    |
    +----java.io.OutputStream
            |
            +----java.io.FilterOutputStream
                    |
                    +----java.io.DataOutputStream
                            |
                            +----vq.utils.vqos
Contents
Package index
Package
API index

public class vqos
extends java.io.DataOutputStream
Adaptor class for writing to HTTP protocol streams and vqServer .cfg file format files.


Constructor Index

 o vqos(File)
Creates a new buffered stream to write to the specified file.
 o vqos(OutputStream)
Creates a new stream for writing to the specified stream.
 o vqos(String)
Creates a new buffered stream to write to the specified file.
 o vqos(String, boolean)
Creates a new buffered stream to write to the specified file.

Method Index

 o closeblock()
Closes a block in a vqServer .cfg file format file.
 o encode(String)
Encodes the string specified in vqServer .cfg file format.
 o openblock(String)
Writes the specified block name in vqServer .cfg file format.
 o write(char)
Writes a single byte representation of the specified character.
 o write(String)
Writes a single byte per character representation of the specified string.
 o writebool(String, boolean)
Writes the specified boolean field (name and value) in vqServer .cfg file format. Deprecated
 o writefield(String, boolean)
Writes the specified boolean field (name and value) in vqServer .cfg file format.
 o writefield(String, long)
Writes the specified numerical field (name and value) in vqServer .cfg file format.
 o writefield(String, String)
Writes the specified field (name and value) in vqServer .cfg file format.
 o writeln()
Writes a single byte per character representation of carriage return line feed.
 o writeln(String)
Writes a single byte per character representation of the specified string, followed by carriage return line feed.
 o writename(String)
Writes the specified field name in vqServer .cfg file format.
 o writevalue(String)
Writes the specified field value in vqServer .cfg file format.

Constructor Detail

 o vqos
public vqos(java.io.OutputStream os) throws java.io.IOException
          Creates a new stream for writing to the specified stream.
Parameters:
os - the output stream to write to
 o vqos
public vqos(java.io.File theFile) throws java.io.IOException
          Creates a new buffered stream to write to the specified file. The contents of the file (if any) are overwritten.
Parameters:
theFile - the file to write to
 o vqos
public vqos(java.lang.String fileName) throws java.io.IOException
          Creates a new buffered stream to write to the specified file. The contents of the file (if any) are overwritten.
Parameters:
fileName - the name of the file to write to
 o vqos
public vqos(java.lang.String fileName,
            boolean append) throws java.io.IOException
          Creates a new buffered stream to write to the specified file. Data will be appended to the existing file if append is true.
Parameters:
fileName - the name of the file to write to
append - append mode

Method Detail

 o write
public void write(char theChar) throws java.io.IOException
          Writes a single byte representation of the specified character.
Parameters:
theChar - the character to write
 o write
public void write(java.lang.String theString) throws java.io.IOException
          Writes a single byte per character representation of the specified string.
Parameters:
theString - the string to write
 o writeln
public void writeln() throws java.io.IOException
          Writes a single byte per character representation of carriage return line feed.
 o writeln
public void writeln(java.lang.String theString) throws java.io.IOException
          Writes a single byte per character representation of the specified string, followed by carriage return line feed.
Parameters:
theString - the string to write
 o encode
public static java.lang.String encode(java.lang.String theString)
          Encodes the string specified in vqServer .cfg file format.
Parameters:
theString - the string to encode
Returns:
the encoded string
 o writename
public void writename(java.lang.String theName) throws java.io.IOException
          Writes the specified field name in vqServer .cfg file format.
Parameters:
theName - the field name to write
 o openblock
public void openblock(java.lang.String theName) throws java.io.IOException
          Writes the specified block name in vqServer .cfg file format.
Parameters:
theName - the name of the block
 o closeblock
public void closeblock() throws java.io.IOException
          Closes a block in a vqServer .cfg file format file.
 o writevalue
public void writevalue(java.lang.String theValue) throws java.io.IOException
          Writes the specified field value in vqServer .cfg file format.
Parameters:
theValue - the field value to write
 o writefield
public void writefield(java.lang.String theName,
                       java.lang.String theValue) throws java.io.IOException
          Writes the specified field (name and value) in vqServer .cfg file format.
Parameters:
theName - the field name to write
theValue - the field value to write
 o writefield
public void writefield(java.lang.String theName,
                       long theNumber) throws java.io.IOException
          Writes the specified numerical field (name and value) in vqServer .cfg file format.
Parameters:
theName - the field name to write
theNumber - the numerical field value to write
 o writefield
public void writefield(java.lang.String theName,
                       boolean theValue) throws java.io.IOException
          Writes the specified boolean field (name and value) in vqServer .cfg file format.
Parameters:
theName - the field name to write
theValue - the boolean field value to write
 o writebool
public void writebool(java.lang.String theName,
                      boolean theValue) throws java.io.IOException
Note: writebool() is deprecated.

          Writes the specified boolean field (name and value) in vqServer .cfg file format.

Parameters:
theName - the field name to write
theValue - the boolean field value to write


vqServer API version 1.9. vqServer and the vqServer API are copyright © Steve Shering and vqSoft 1997-2000. Last updated 15 May 2000.

Contents
Package index
Package
API index