csConfigFile

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

crystalspace.jbind.impl.csutil.cfgfile
Class csConfigFile

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

All Implemented Interfaces:: iBase, iConfigFile, iPointer

Direct Known Subclasses:: csConfigManager

public class csConfigFile
extends csBase
implements iConfigFile

Author:: Quentin Anciaux

Field Summary

Fields inherited from class crystalspace.jbind.impl.csNativeObject

ImplFactory, nPointer

Constructor Summary
`csConfigFile(iPointer nPointer)`

Method Summary
`void`	`clear()` Delete all options and rewind all iterators.
`void`	`deleteKey(java.lang.String Key)` Delete a key and its value and comment.
`iConfigIterator`	`enumerate()` Enumerate selected keys.
`iConfigIterator`	`enumerate(java.lang.String Subsection)` Enumerate selected keys.
`boolean`	`getBool(java.lang.String Key)` Get a booleanean value from the configuration.
`boolean`	`getBool(java.lang.String Key, boolean Def)` Get a booleanean value from the configuration.
`java.lang.String`	`getComment(java.lang.String Key)` Get the comment of the given key, or 0 if no comment exists.
`java.lang.String`	`getEOFComment()` return the final comment at the end of the configuration file Implemented in csWin32RegistryConfig, csConfigFile, csConfigManager, and csDefaultsConfig.
`java.lang.String`	`getFileName()` Get configuration file name.
`float`	`getFloat(java.lang.String Key)` Get a float value from the configuration.
`float`	`getFloat(java.lang.String Key, float Def)` Get a float value from the configuration.
`int`	`getInt(java.lang.String Key)` Get an integer value from the configuration.
`int`	`getInt(java.lang.String Key, int Def)` Get an integer value from the configuration.
`static java.lang.Class`	`getInterfaceClass()`
`static java.lang.String`	`getInterfaceName()`
`static int`	`getInterfaceVersion()`
`java.lang.String`	`getName()` Return the name of the interface
`java.lang.String`	`getStr(java.lang.String Key)` Get a string value from the configuration.
`java.lang.String`	`getStr(java.lang.String Key, java.lang.String Def)` Get a string value from the configuration.
`int`	`getVersion()` Return the version of the interface
`iVFS`	`getVFS()` Get the VFS object on which this file is stored (if any);.
`static void`	`initSCF()`
`protected boolean`	`isNativePointerValidSafe(long pointer)`
`boolean`	`keyExists(java.lang.String Key)` Test if a key exists.
`boolean`	`load(java.lang.String iFileName)` Load a configuration file.
`boolean`	`load(java.lang.String iFileName, iVFS vfs)` Load a configuration file.
`boolean`	`load(java.lang.String iFileName, iVFS vfs, boolean Merge)` Load a configuration file.
`boolean`	`load(java.lang.String iFileName, iVFS vfs, boolean Merge, boolean NewWins)` Load a configuration file.
`boolean`	`save()` Save configuration to the same place from which it was loaded.
`boolean`	`save(java.lang.String iFileName)` Save configuration into the given file (on VFS or on the physical filesystem);.
`boolean`	`save(java.lang.String iFileName, iVFS vfs)` Save configuration into the given file (on VFS or on the physical filesystem);.
`void`	`setBool(java.lang.String Key, boolean Value)` Set a booleanean value.
`void`	`setComment(java.lang.String Key, java.lang.String Text)` Set the comment for given key.
`void`	`setEOFComment(java.lang.String Text)` set the final comment at the end of the configuration file Implemented in csWin32RegistryConfig, csConfigFile, csConfigManager, and csDefaultsConfig.
`void`	`setFileName(java.lang.String Name, iVFS vfs)` Set config file name.
`void`	`setFloat(java.lang.String Key, float Value)` Set a floating-point value.
`void`	`setInt(java.lang.String Key, int Value)` Set an integer value.
`void`	`setStr(java.lang.String Key, java.lang.String Val)` Set an string value.
`boolean`	`subsectionExists(java.lang.String Subsection)` Test if at least one key exists with the given Subsection prefix.

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

csConfigFile

public csConfigFile(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)