vqServer API Class vq.utils.vqis

java.lang.Object
    |
    +----java.io.InputStream
            |
            +----java.io.FilterInputStream
                    |
                    +----java.io.DataInputStream
                            |
                            +----vq.utils.vqis
Contents
Package index
Package
API index

public class vqis
extends java.io.DataInputStream
Adaptor class for reading from HTTP protocol streams and vqServer .cfg file format files. Each byte is interpreted as a whole character.


Variable Index

 o last
The last byte read from the stream.

Constructor Index

 o vqis(File)
Creates a new buffered stream to read from the specified file.
 o vqis(InputStream)
Creates a new stream for reading from the specified stream.
 o vqis(String)
Creates a new buffered stream to read from the specified file.
 o vqis(String, String)
Creates a new buffered stream to read from the specified location using the specified mode.

Method Index

 o read()
Reads the next byte from the underlying stream.
 o readbool()
Reads a boolean field value written in vqServer .cfg file format.
 o readchar()
Reads the next byte from the underlying stream and returns it as a char.
 o readdate()
Reads a date field value written in vqServer .cfg file format.
 o readln()
Reads up to and including the next line break from the underlying stream.
 o readlong()
Reads a long field value written in vqServer .cfg file format.
 o readname()
Reads a field name written in vqServer .cfg file format.
 o readtrimln()
Reads up to and including the next line break from the underlying stream.
 o readvalue()
Reads a field value written in vqServer .cfg file format.
 o readword(String)
Reads up to and including the next word break from the underlying stream.

Field Detail

 o last
public int last
          The last byte read from the stream.

Constructor Detail

 o vqis
public vqis(java.io.InputStream is)
          Creates a new stream for reading from the specified stream.
Parameters:
is - the input stream to read from
 o vqis
public vqis(java.lang.String fname) throws java.io.IOException
          Creates a new buffered stream to read from the specified file.
Parameters:
fname - the name of the file to read from
 o vqis
public vqis(java.io.File file) throws java.io.IOException
          Creates a new buffered stream to read from the specified file.
Parameters:
file - the file to read from
 o vqis
public vqis(java.lang.String mode,
            java.lang.String fname) throws java.io.IOException
          Creates a new buffered stream to read from the specified location using the specified mode. Currently identical to vqis(String fname).
Parameters:
mode - the mode to use
fname - the name of the file to read from

Method Detail

 o read
public int read() throws java.io.IOException
          Reads the next byte from the underlying stream.
Returns:
the byte read
Overrides:
read in class java.io.FilterInputStream
 o readchar
public char readchar() throws java.io.IOException
          Reads the next byte from the underlying stream and returns it as a char.
Returns:
the character read
 o readword
public java.lang.String readword(java.lang.String stopChars) throws java.io.IOException
          Reads up to and including the next word break from the underlying stream. Word breaks include the space character, characters in stopChars, the end of the line and the end of file. Copes with lines terminated by both line feed and carriage return line feed.
Parameters:
stopChars - word break characters
Returns:
the word read (excluding the word break character(s)) as a string
 o readln
public java.lang.String readln() throws java.io.IOException
          Reads up to and including the next line break from the underlying stream. Line breaks include the end of file. Copes with lines terminated by both line feed and carriage return - line feed.
Returns:
the line read (including leading and trailing spaces and the line break character(s) as a String
 o readtrimln
public java.lang.String readtrimln() throws java.io.IOException
          Reads up to and including the next line break from the underlying stream. Line breaks include the end of file. Copes with lines terminated by both line feed and carriage return - line feed.
Returns:
the line read (excluding leading and trailing spaces and the line break character(s) as a String
 o readname
public java.lang.String readname() throws java.io.IOException
          Reads a field name written in vqServer .cfg file format.
Returns:
the field name read
 o readvalue
public java.lang.String readvalue() throws java.io.IOException
          Reads a field value written in vqServer .cfg file format.
Returns:
the field value read
 o readbool
public boolean readbool() throws java.io.IOException
          Reads a boolean field value written in vqServer .cfg file format.
Returns:
the boolean value read
 o readlong
public long readlong() throws java.io.IOException
          Reads a long field value written in vqServer .cfg file format.
Returns:
the long value read
 o readdate
public long readdate() throws java.io.IOException
          Reads a date field value written in vqServer .cfg file format.
Returns:
the date read as a long


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