crystalspace.jbind.interfaces.iutil.object
Interface iObject

All Superinterfaces:

iBase, iPointer

All Known Implementing Classes:

csObject

public interface iObject

extends iBase

This interface is an SCF interface for encapsulating csObject.

Author:

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

Method Summary

iPointer	getChild(int iInterfaceID, int iVersion) Look for a child object that implements the given interface.
iPointer	getChild(int iInterfaceID, int iVersion, java.lang.String Name) Look for a child object that implements the given interface.
iPointer	getChild(int iInterfaceID, int iVersion, java.lang.String Name, boolean FirstName) Look for a child object that implements the given interface.
iObject	getChild(java.lang.String Name) Return the first child object with the given name.
int	getID() Get the unique ID associated with this object.
iObjectIterator	getIterator() Return an iterator for all child objects.
java.lang.String	getName() Query object name.
iObject	getObjectParent() Returns the parent iObject.
void	objAdd(iObject obj) Attach a new iObject to the tree.
void	objAddChildren(iObject Parent) Add all child objects of the given object.
void	objRemove(iObject obj) Remove an iObject from the tree.
void	objRemoveAll() Remove all child objects.
void	setName(java.lang.String iName) Set object name.
void	setObjectParent(iObject obj) Set the parent iObject.

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

decRef, getRefCount, getVersion, incRef, queryInterface, queryInterfaceSafe

Methods inherited from interface crystalspace.jbind.interfaces.iPointer

changePointer, getPointer, isMemoryOwner, setMemoryOwner

Method Detail

getChild

public iObject getChild(java.lang.String Name)

Return the first child object with the given name. Implemented in csObject.

Parameters:

Name -

Returns:

getChild

public iPointer getChild(int iInterfaceID,
                         int iVersion)

Look for a child object that implements the given interface. You can optionally pass a name to look for. If FirstName is true then the method will stop at the first object with the requested name, even if it did not implement the requested type. Note that the returned object may only be cast to the requested type, no other type, not even iObject! Note that the returned object will be IncRef'ed. Implemented in csObject.

Parameters:

iInterfaceID -

iVersion -

Returns:

getChild

public iPointer getChild(int iInterfaceID,
                         int iVersion,
                         java.lang.String Name)

Look for a child object that implements the given interface. You can optionally pass a name to look for. If FirstName is true then the method will stop at the first object with the requested name, even if it did not implement the requested type. Note that the returned object may only be cast to the requested type, no other type, not even iObject! Note that the returned object will be IncRef'ed. Implemented in csObject.

Parameters:

iInterfaceID -

iVersion -

Name -

Returns:

getChild

public iPointer getChild(int iInterfaceID,
                         int iVersion,
                         java.lang.String Name,
                         boolean FirstName)

Look for a child object that implements the given interface. You can optionally pass a name to look for. If FirstName is true then the method will stop at the first object with the requested name, even if it did not implement the requested type. Note that the returned object may only be cast to the requested type, no other type, not even iObject! Note that the returned object will be IncRef'ed. Implemented in csObject.

Parameters:

iInterfaceID -

iVersion -

Name -

FirstName -

Returns:

getID

public int getID()

Get the unique ID associated with this object. Implemented in csObject.

Returns:

getIterator

public iObjectIterator getIterator()

Return an iterator for all child objects. Note that you should not remove child objects while iterating. Implemented in csObject.

Returns:

getName

public java.lang.String getName()

Query object name. Implemented in csObject.

Specified by:

getName in interface iBase

Returns:

getObjectParent

public iObject getObjectParent()

Returns the parent iObject. Implemented in csObject.

Returns:

objAdd

public void objAdd(iObject obj)

Attach a new iObject to the tree. Implemented in csObject.

Parameters:

obj -

objAddChildren

public void objAddChildren(iObject Parent)

Add all child objects of the given object. Implemented in csObject.

Parameters:

Parent -

objRemove

public void objRemove(iObject obj)

Remove an iObject from the tree. Implemented in csObject.

Parameters:

obj -

objRemoveAll

public void objRemoveAll()

Remove all child objects. Implemented in csObject.

setName

public void setName(java.lang.String iName)

Set object name. Implemented in csObject.

Parameters:

iName -

setObjectParent

public void setObjectParent(iObject obj)

Set the parent iObject. Note that this only sets the 'parent' pointer but does not add the object as a child object. Implemented in csObject.

Parameters:

obj -