crystalspace.jbind.interfaces.iutil.cfgfile
Interface iConfigIterator

All Superinterfaces:

iBase, iPointer

All Known Implementing Classes:

csConfigIterator

public interface iConfigIterator

extends iBase

Iterator which allows sequential access to configuration information contained in an iConfigFile object.

Author:

Java wrapper - Quentin Anciaux, c++ version - http://crystal.sourceforge.net/docs/online/devapi/structiConfigIterator.php

Method Summary

boolean	getBool() Get a boolean value from the configuration.
java.lang.String	getComment() Get the comment of the given key, or 0 if no comment exists.
iConfigFile	getConfigFile() Returns the configuration object for this iterator.
float	getFloat() Get a float value from the configuration.
int	getInt() Get an integer value from the configuration.
java.lang.String	getKey() Get the current key name.
java.lang.String	getKey(boolean Local) Get the current key name.
java.lang.String	getStr() Get a string value from the configuration.
java.lang.String	getSubsection() Returns the subsection in the configuruation.
boolean	next() Move to the next valid key.
void	rewind() Rewind the iterator (points to nowhere after this);.

Methods inherited from interface crystalspace.jbind.interfaces.iutil.scf.iBase

decRef, getName, getRefCount, getVersion, incRef, queryInterface, queryInterfaceSafe

Methods inherited from interface crystalspace.jbind.interfaces.iPointer

changePointer, getPointer, isMemoryOwner, setMemoryOwner

Method Detail

getBool

public boolean getBool()

Get a boolean value from the configuration. Implemented in csWin32RegistryIterator, and csDefaultsIterator.

Returns:

getComment

public java.lang.String getComment()

Get the comment of the given key, or 0 if no comment exists. Implemented in csWin32RegistryIterator, and csDefaultsIterator.

Returns:

getConfigFile

public iConfigFile getConfigFile()

Returns the configuration object for this iterator. Implemented in csWin32RegistryIterator, and csDefaultsIterator.

Returns:

getFloat

public float getFloat()

Get a float value from the configuration. Implemented in csWin32RegistryIterator, and csDefaultsIterator.

Returns:

getInt

public int getInt()

Get an integer value from the configuration. Implemented in csWin32RegistryIterator, and csDefaultsIterator.

Returns:

getKey

public java.lang.String getKey()

Get the current key name. Set Local to true to return only the local name inside the iterated subsection. This is the portion of the key string which follows the subsection prefix which was used to create this iterator. Implemented in csWin32RegistryIterator, and csDefaultsIterator.

Returns:

getKey

public java.lang.String getKey(boolean Local)

Get the current key name. Set Local to true to return only the local name inside the iterated subsection. This is the portion of the key string which follows the subsection prefix which was used to create this iterator. Implemented in csWin32RegistryIterator, and csDefaultsIterator.

Parameters:

Local -

Returns:

getStr

public java.lang.String getStr()

Get a string value from the configuration. Implemented in csWin32RegistryIterator, and csDefaultsIterator.

Returns:

getSubsection

public java.lang.String getSubsection()

Returns the subsection in the configuruation. Implemented in csWin32RegistryIterator, and csDefaultsIterator.

Returns:

next

public boolean next()

Move to the next valid key. Returns false if no more keys exist. Implemented in csWin32RegistryIterator, and csDefaultsIterator.

Returns:

rewind

public void rewind()

Rewind the iterator (points to nowhere after this);. Implemented in csWin32RegistryIterator, and csDefaultsIterator