org.openquark.gems.client
Class Argument.LoadInfo

java.lang.Object
  org.openquark.gems.client.Argument.LoadInfo

Enclosing class:

Argument

public static class Argument.LoadInfo
extends Object

This is a class to encapsulate information about an argument during the load process. This is used in cases where information about the argument is obtained at an earlier stage in the load process from where the information can actually be used.

Author:

Edward Lam

Constructor Summary

Argument.LoadInfo()
Trivial constructor for this class.

Method Summary

void	addArgument(Gem gem, String inputGemId, Integer inputIndex)
void	addArgument(Gem gem, String inputGemId, Integer inputIndex, Object otherInfo) Add an argument to this load info object.
org.openquark.util.Pair<String,Integer>	getInputInfo(Gem gem, int argumentIndex) Get the input information held by this info object.
int	getNArguments(Gem gem) Get the number of arguments associated with a given gem.
Object	getOtherInfo(Gem gem, int argumentIndex) Get the non-input information held by this info object.
void	remapGem(Gem oldGem, Gem newGem) Change the info in this load info object so that getting info for a given gem returns the info for another gem.

Methods inherited from class java.lang.Object

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

Constructor Detail

Argument.LoadInfo

public Argument.LoadInfo()

Trivial constructor for this class.

Method Detail

addArgument

public void addArgument(Gem gem,
                        String inputGemId,
                        Integer inputIndex)

See Also:

{

addArgument

public void addArgument(Gem gem,
                        String inputGemId,
                        Integer inputIndex,
                        Object otherInfo)

Add an argument to this load info object.

Parameters:

gem - the gem associated with the argument.

inputGemId - the id of the gem on which the input appears.

inputIndex - the index of the inputs on the gem in which it appears.

otherInfo - any other info to associate with the input. May be null.

remapGem

public void remapGem(Gem oldGem,
                     Gem newGem)

Change the info in this load info object so that getting info for a given gem returns the info for another gem.

Parameters:

oldGem - the gem to be replaced.

newGem - the gem for which, when asked for its info, the info for oldGem will be returned.

getNArguments

public int getNArguments(Gem gem)

Get the number of arguments associated with a given gem.

Parameters:

gem - the gem in question.

Returns:

the number of arguments associated with a given gem.

getInputInfo

public org.openquark.util.Pair<String,Integer> getInputInfo(Gem gem,
                                                            int argumentIndex)

Get the input information held by this info object.

Parameters:

gem - the gem for which the argument info is relevant.

argumentIndex - the index of the argument within the gem's argument info.

Returns:

Pair of (input gem id, input index)

getOtherInfo

public Object getOtherInfo(Gem gem,
                           int argumentIndex)

Get the non-input information held by this info object.

Parameters:

gem - the gem for which the argument info is relevant.

argumentIndex - the index of the argument within the gem's argument info.

Returns:

the other info associated with the argument - may be null.