vqServer API Class vq.utils.klentry

java.lang.Object
    |
    +----vq.utils.klentry
Contents
Package index
Package
API index

public class klentry
extends java.lang.Object
An entry in a kllist. Many of vqServer's internal objects extend this class.

See Also:
kllist

Variable Index

 o key
A string which identifies the entry.

Constructor Index

 o klentry()
Creates an unattached entry whose key is "".
 o klentry(String)
Creates an unattached entry with the specified key.
 o klentry(String, vqis)
Creates an unattached entry with the specified key and reads and discards any data in the specified input stream up to and including the end of the current field or block.

Method Index

 o kill()
Kills the entry.
 o next()
Returns the next entry in the list or null if the entry is the last entry in the list or is not in a list.
 o prev()
Returns the previous entry in the list or null if the entry is the first entry in the list or is not in a list.
 o save(vqos)
Writes the entry to the output stream specified in vqServer .cfg file format.

Field Detail

 o key
public java.lang.String key
          A string which identifies the entry. Warning: most descendants of klentry in the vq.server package attach a special meaning to this property. It should not be changed. It is exposed for efficiency and compatibility reasons.

Constructor Detail

 o klentry
public klentry()
          Creates an unattached entry whose key is "".
 o klentry
public klentry(java.lang.String theKey)
          Creates an unattached entry with the specified key.
Parameters:
theKey - the key of the new entry
 o klentry
public klentry(java.lang.String theKey,
               vqis is) throws java.io.IOException
          Creates an unattached entry with the specified key and reads and discards any data in the specified input stream up to and including the end of the current field or block. Used when reading a list of entries from a file in vqServer .cfg file format.
Parameters:
theKey - the key of the new entry
is - the input stream the entry is being read from

Method Detail

 o kill
public void kill()
          Kills the entry. Warning: do not invoke this method if the entry is a member of a list.
 o save
public void save(vqos os) throws java.io.IOException
          Writes the entry to the output stream specified in vqServer .cfg file format.
Parameters:
os - the output stream to write the entry to
 o next
public klentry next()
          Returns the next entry in the list or null if the entry is the last entry in the list or is not in a list.
Returns:
the next entry in the list
 o prev
public klentry prev()
          Returns the previous entry in the list or null if the entry is the first entry in the list or is not in a list.
Returns:
the previous entry in the list


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