Package org.frankframework.parameters

Class ParameterList

java.lang.Object

org.frankframework.parameters.ParameterList

All Implemented Interfaces:

Iterable<IParameter>

public class ParameterList
extends Object
implements Iterable<IParameter>

List of parameters.

Author:

Gerrit van Brakel

Constructor Summary

Constructors

Constructor	Description
ParameterList()
ParameterList(ParameterList parameterList)

Method Summary

Modifier and Type	Method	Description
boolean	add(IParameter param)
void	clear()
void	configure()
boolean	consumesSessionVariable(String sessionKey)
IParameter	findParameter(String name)
void	forEach(Consumer<? super IParameter> action)
IParameter	getParameter(int i)
List<String>	getParameterNames()	Get a list of all parameter names in this ParameterList.
ParameterValue	getValue(ParameterValueList alreadyResolvedParameters, IParameter p, Message message, PipeLineSession session, boolean namespaceAware)
ParameterValueList	getValues(Message message, PipeLineSession session)
ParameterValueList	getValues(Message message, PipeLineSession session, boolean namespaceAware)	Returns a List of ParameterValue objects
boolean	hasParameter(String name)
boolean	isEmpty()
Iterator<IParameter>	iterator()
IParameter	remove(String name)
boolean	remove(IParameter param)
int	size()
Spliterator<IParameter>	spliterator()
Stream<IParameter>	stream()

Methods inherited from class java.lang.Object

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

Constructor Details

ParameterList

public ParameterList()

ParameterList

public ParameterList(@Nullable
 ParameterList parameterList)

Method Details

clear

public void clear()

configure

public void configure()
               throws ConfigurationException

Throws:

ConfigurationException

add

public boolean add(IParameter param)

remove

public boolean remove(IParameter param)

remove

public IParameter remove(String name)

getParameter

public IParameter getParameter(int i)

findParameter

public IParameter findParameter(String name)

hasParameter

public boolean hasParameter(String name)

getValues

@Nonnull
public ParameterValueList getValues(Message message,
 PipeLineSession session)
                             throws ParameterException

Throws:

ParameterException

getValues

@Nonnull
public ParameterValueList getValues(Message message,
 PipeLineSession session,
 boolean namespaceAware)
                             throws ParameterException

Returns a List of ParameterValue objects

Throws:

ParameterException

getValue

public ParameterValue getValue(ParameterValueList alreadyResolvedParameters,
 @Nonnull
 IParameter p,
 Message message,
 PipeLineSession session,
 boolean namespaceAware)
                        throws ParameterException

Throws:

ParameterException

consumesSessionVariable

public boolean consumesSessionVariable(String sessionKey)

isEmpty

public boolean isEmpty()

iterator

@Nonnull
public Iterator<IParameter> iterator()

Specified by:

iterator in interface Iterable<IParameter>

forEach

public void forEach(Consumer<? super IParameter> action)

Specified by:

forEach in interface Iterable<IParameter>

spliterator

public Spliterator<IParameter> spliterator()

Specified by:

spliterator in interface Iterable<IParameter>

stream

@Nonnull
public Stream<IParameter> stream()

size

public int size()

getParameterNames

@Nonnull
public List<String> getParameterNames()

Get a list of all parameter names in this ParameterList. Names do not need to be unique unless

invalid reference

#setNamesMustBeUnique(boolean)

has been set to true, they will appear multiple times in the list if they are present multiple times in the ParameterList.