crystalspace.jbind.impl.csutil.cfgfile
Class csConfigIterator

java.lang.Object
  crystalspace.jbind.impl.csNativeObject
      crystalspace.jbind.impl.csutil.scf.csBase
          crystalspace.jbind.impl.csutil.cfgfile.csConfigIterator

All Implemented Interfaces:

iBase, iConfigIterator, iPointer

public class csConfigIterator

extends csBase

implements iConfigIterator

Author:

Quentin Anciaux

Field Summary

Fields inherited from class crystalspace.jbind.impl.csNativeObject

ImplFactory, nPointer

Constructor Summary

csConfigIterator(iPointer nPointer)

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.
static java.lang.Class	getInterfaceClass()
static java.lang.String	getInterfaceName()
static int	getInterfaceVersion()
java.lang.String	getKey() Get the current key name.
java.lang.String	getKey(boolean Local) Get the current key name.
java.lang.String	getName() Return the name of the interface
java.lang.String	getStr() Get a string value from the configuration.
java.lang.String	getSubsection() Returns the subsection in the configuruation.
int	getVersion() Return the version of the interface
static void	initSCF()
protected boolean	isNativePointerValidSafe(long pointer)
boolean	next() Move to the next valid key.
void	rewind() Rewind the iterator (points to nowhere after this);.

Methods inherited from class crystalspace.jbind.impl.csutil.scf.csBase

decRef, equals, finalize, getRefCount, incRef, nDelete, queryInterface, queryInterfaceSafe

Methods inherited from class crystalspace.jbind.impl.csNativeObject

changePointer, getPointer, getPointer, getPointerArray, hashCode, isMemoryOwner, isNativePointerValid, newNativeObject, setMemoryOwner, toString

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

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

decRef, getRefCount, incRef, queryInterface, queryInterfaceSafe

Methods inherited from interface crystalspace.jbind.interfaces.iPointer

changePointer, getPointer, isMemoryOwner, setMemoryOwner

Constructor Detail

csConfigIterator

public csConfigIterator(iPointer nPointer)

Parameters:

nPointer -

Method Detail

getVersion

public int getVersion()

Description copied from interface: iBase

Return the version of the interface

Specified by:

getVersion in interface iBase

Specified by:

getVersion in class csBase

getName

public java.lang.String getName()

Description copied from interface: iBase

Return the name of the interface

Specified by:

getName in interface iBase

Specified by:

getName in class csBase

initSCF

public static void initSCF()

getInterfaceVersion

public static int getInterfaceVersion()

getInterfaceName

public static java.lang.String getInterfaceName()

getInterfaceClass

public static java.lang.Class getInterfaceClass()

isNativePointerValidSafe

protected boolean isNativePointerValidSafe(long pointer)

Specified by:

isNativePointerValidSafe in class csNativeObject

See Also:

csNativeObject.isNativePointerValidSafe(long)

getBool

public boolean getBool()

Description copied from interface: iConfigIterator

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

Specified by:

getBool in interface iConfigIterator

Returns:

See Also:

iConfigIterator.getBool()

getComment

public java.lang.String getComment()

Description copied from interface: iConfigIterator

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

Specified by:

getComment in interface iConfigIterator

Returns:

See Also:

crystalspace.jbind.interfaces.iutil.cfgfile.iConfigIterator#GetComment()

getConfigFile

public iConfigFile getConfigFile()

Description copied from interface: iConfigIterator

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

Specified by:

getConfigFile in interface iConfigIterator

Returns:

See Also:

iConfigIterator.getConfigFile()

getFloat

public float getFloat()

Description copied from interface: iConfigIterator

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

Specified by:

getFloat in interface iConfigIterator

Returns:

See Also:

iConfigIterator.getFloat()

getInt

public int getInt()

Description copied from interface: iConfigIterator

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

Specified by:

getInt in interface iConfigIterator

Returns:

See Also:

iConfigIterator.getInt()

getKey

public java.lang.String getKey()

Description copied from interface: iConfigIterator

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.

Specified by:

getKey in interface iConfigIterator

Returns:

See Also:

iConfigIterator.getKey()

getKey

public java.lang.String getKey(boolean Local)

Description copied from interface: iConfigIterator

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.

Specified by:

getKey in interface iConfigIterator

Parameters:

Local -

Returns:

See Also:

iConfigIterator.getKey(boolean)

getStr

public java.lang.String getStr()

Description copied from interface: iConfigIterator

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

Specified by:

getStr in interface iConfigIterator

Returns:

See Also:

iConfigIterator.getStr()

getSubsection

public java.lang.String getSubsection()

Description copied from interface: iConfigIterator

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

Specified by:

getSubsection in interface iConfigIterator

Returns:

See Also:

iConfigIterator.getSubsection()

next

public boolean next()

Description copied from interface: iConfigIterator

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

Specified by:

next in interface iConfigIterator

Returns:

See Also:

iConfigIterator.next()

rewind

public void rewind()

Description copied from interface: iConfigIterator

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

Specified by:

rewind in interface iConfigIterator

See Also:

iConfigIterator.rewind()