com.simplifiedlogic.nitro.util

Class ParamLooper

java.lang.Object

com.simplifiedlogic.nitro.util.ParamLooper

Direct Known Subclasses:

JLParameter.BasicListLooper, JLParameter.DeleteLooper2, JLParameter.ExistsLooper, JLParameter.SetDesignateLooper2, ParamListLooper

public abstract class ParamLooper
extends java.lang.Object

This is an abstract class which loops over parameters on an object, filters the results by various filters, and calls an action method for each parameter which matches the filters.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	currentName The name of the current parameter in the loop

Constructor Summary

Constructors

Constructor and Description
ParamLooper()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String[]	getNameList()
java.lang.String	getNamePattern()
void	loop(CallParameterOwner m) Loop through parameters on an object
abstract boolean	loopAction(CallParameter p) Abstract function which is called for each parameter which matches the filters.
void	setNameList(java.util.List<java.lang.String> nameList)
void	setNamePattern(java.lang.String namePattern)

Methods inherited from class java.lang.Object

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

Field Detail

currentName

protected java.lang.String currentName

The name of the current parameter in the loop

Constructor Detail

ParamLooper

public ParamLooper()

Method Detail

loop

public void loop(CallParameterOwner m)
          throws JLIException,
                 com.ptc.cipjava.jxthrowable

Loop through parameters on an object

Parameters:

m - The parameter owner

Throws:

JLIException

com.ptc.cipjava.jxthrowable

loopAction

public abstract boolean loopAction(CallParameter p)
                            throws JLIException,
                                   com.ptc.cipjava.jxthrowable

Abstract function which is called for each parameter which matches the filters. This must be implemented by a class extending this looper class.

Parameters:

p - The parameter that matches the filters

Returns:

True to abort the loop, false to continue it

Throws:

JLIException

com.ptc.cipjava.jxthrowable

getNamePattern

public java.lang.String getNamePattern()

Returns:

The name filter

setNamePattern

public void setNamePattern(java.lang.String namePattern)

Parameters:

namePattern - The name filter

getNameList

public java.lang.String[] getNameList()

Returns:

The list of name filters

setNameList

public void setNameList(java.util.List<java.lang.String> nameList)

Parameters:

nameList - The list of name filters