com.interfaceware.chameleon
Class Config

java.lang.Object
  com.interfaceware.chameleon.Config

public class Config
extends java.lang.Object

This class allows access to programmatically change delimiter characters. The Config object should not be created directly but instead should be obtained from the Engine.config() method.

See Also:

http://www.interfaceware.com/manual/delimiter_characters.html

Constructor Summary

Config(long Handle)
Construct a Config object with the specified config handle.

Method Summary

int	countOfDelimiter() Get the number of delimiter characters.
protected void	finalize() Finalizer that invokes the release method.
int	getDelimiterChar(int CharIndex) Get the delimiter character at CharIndex.
int	getEscapeCharacter() Get the escape character.
int	getRepeatCharacter() Get the repeat character.
long	handle() Get the Config object handle.
void	release() Free the Config object handle.
void	setDelimiterChar(int CharIndex, int NewValue) Set the delimiter character at CharIndex to NewValue.
void	setEscapeCharacter(int NewValue) Set the escape character to NewValue.
void	setRepeatCharacter(int NewValue) Set the repeat character to NewValue.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Config

public Config(long Handle)
       throws ChameleonException

Construct a Config object with the specified config handle. This constructor is used in the internal implementation of Chameleon and should not be invoked directly. To obtain a Config object use the Engine.config() method.

Throws:

ChameleonException

Method Detail

release

public void release()
             throws ChameleonException

Free the Config object handle.

Throws:

ChameleonException

finalize

protected void finalize()
                 throws ChameleonException

Finalizer that invokes the release method.

Overrides:

finalize in class java.lang.Object

Throws:

ChameleonException

countOfDelimiter

public int countOfDelimiter()
                     throws ChameleonException

Get the number of delimiter characters.

Throws:

ChameleonException

See Also:

http://www.interfaceware.com/manual/delimiter_characters.html

setDelimiterChar

public void setDelimiterChar(int CharIndex,
                             int NewValue)
                      throws ChameleonException

Set the delimiter character at CharIndex to NewValue.

Throws:

ChameleonException

See Also:

http://www.interfaceware.com/manual/delimiter_characters.html

getDelimiterChar

public int getDelimiterChar(int CharIndex)
                     throws ChameleonException

Get the delimiter character at CharIndex.

Throws:

ChameleonException

See Also:

http://www.interfaceware.com/manual/delimiter_characters.html

setEscapeCharacter

public void setEscapeCharacter(int NewValue)
                        throws ChameleonException

Set the escape character to NewValue. The default escape character is '\'.

Throws:

ChameleonException

See Also:

http://www.interfaceware.com/manual/delimiter_characters.html

getEscapeCharacter

public int getEscapeCharacter()
                       throws ChameleonException

Get the escape character. The default escape character is '\'.

Throws:

ChameleonException

See Also:

http://www.interfaceware.com/manual/delimiter_characters.html

setRepeatCharacter

public void setRepeatCharacter(int NewValue)
                        throws ChameleonException

Set the repeat character to NewValue. The default repeat character is '~'.

Throws:

ChameleonException

See Also:

http://www.interfaceware.com/manual/delimiter_characters.html

getRepeatCharacter

public int getRepeatCharacter()
                       throws ChameleonException

Get the repeat character. The default repeat character is '~'.

Throws:

ChameleonException

See Also:

http://www.interfaceware.com/manual/delimiter_characters.html

handle

public long handle()

Get the Config object handle. This is used in the internal implementation of Chameleon and should not be called directly.