crystalspace.jbind.interfaces.iengine.sharevar
Interface iSharedVariableList

All Superinterfaces:

iBase, iPointer

All Known Implementing Classes:

csSharedVariableList

public interface iSharedVariableList

extends iBase

A list of shared variables.

Author:

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

Method Summary

int	add(iSharedVariable obj) Add a SharedVariable.
int	find(iSharedVariable obj) Find a SharedVariable and return its index.
iSharedVariable	findByName(java.lang.String Name) Find a SharedVariable by name.
iSharedVariable	get(int n) Return a SharedVariable by index.
int	getCount() Return the number of Shared Variables in this list.
iSharedVariable	New() iSharedVariable Factory method.
boolean	remove(int n) Remove the nth SharedVariable.
boolean	remove(iSharedVariable obj) Remove a SharedVariable.
void	removeAll() Remove all SharedVariables.

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

add

public int add(iSharedVariable obj)

Add a SharedVariable.

Parameters:

obj -

Returns:

find

public int find(iSharedVariable obj)

Find a SharedVariable and return its index.

Parameters:

obj -

Returns:

findByName

public iSharedVariable findByName(java.lang.String Name)

Find a SharedVariable by name.

Parameters:

Name -

Returns:

get

public iSharedVariable get(int n)

Return a SharedVariable by index.

Parameters:

n -

Returns:

getCount

public int getCount()

Return the number of Shared Variables in this list.

Returns:

New

public iSharedVariable New()

iSharedVariable Factory method. This does not add the new var to the list.

Returns:

remove

public boolean remove(int n)

Remove the nth SharedVariable.

Parameters:

n -

Returns:

remove

public boolean remove(iSharedVariable obj)

Remove a SharedVariable.

Parameters:

obj -

Returns:

removeAll

public void removeAll()

Remove all SharedVariables.