Class ParameterValueList

java.lang.Object

org.frankframework.parameters.ParameterValueList

All Implemented Interfaces:

Iterable<ParameterValue>

public class ParameterValueList
extends Object
implements Iterable<ParameterValue>

List of ParameterValues.

Author:

Gerrit van Brakel

Constructor Summary

Constructors

Constructor	Description
ParameterValueList()

Method Summary

Modifier and Type	Method	Description
protected void	add(ParameterValue pv)
boolean	contains(@NonNull String name)	Check if the parameter exists, case-insensitive.
@Nullable ParameterValue	get(@NonNull String name)	Get a specific ParameterValue, case sensitive
static ParameterValueList	get(ParameterList params, Message message, PipeLineSession session)
ParameterValue	getValue(int i)
@Nullable String	getValue(@NonNull String parameterName)
int	getValue(@NonNull String parameterName, int defaultValue)
String	getValue(@NonNull String name, @Nullable String defaultValue)
Message	getValue(@NonNull String name, @Nullable Message defaultValue)
@NonNull List<Object>	getValueList()	Get the list of resolved parameter values
@NonNull Map<String,Object>	getValueMap()	Returns a Map of value objects which may be a subset of the ParameterList when multiple parameters exist with the same name!
@NonNull Iterator<ParameterValue>	iterator()	Returns the List iterator which may contain Parameters with the same name!
@Nullable ParameterValue	remove(String name)	Deprecated.
int	size()
Stream<ParameterValue>	stream()

Methods inherited from class Object

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

Methods inherited from interface Iterable

forEach, spliterator

Constructor Details

ParameterValueList

public ParameterValueList()

Method Details

get

public static ParameterValueList get(ParameterList params,
 Message message,
 PipeLineSession session)
                              throws ParameterException

Throws:

ParameterException

add

protected void add(ParameterValue pv)

get

public @Nullable ParameterValue get(@NonNull String name)

Get a specific ParameterValue, case sensitive

contains

public boolean contains(@NonNull String name)

Check if the parameter exists, case-insensitive.

remove

@Deprecated
public @Nullable ParameterValue remove(String name)

Deprecated.

should not be used in combination with iterator()!

getValueMap

public @NonNull Map<String,Object> getValueMap()

Returns a Map of value objects which may be a subset of the ParameterList when multiple parameters exist with the same name!

getValueList

public @NonNull List<Object> getValueList()

Get the list of resolved parameter values

getValue

public int getValue(@NonNull String parameterName,
 int defaultValue)

getValue

public @Nullable String getValue(@NonNull String parameterName)

getValue

public String getValue(@NonNull String name,
 @Nullable String defaultValue)

getValue

public Message getValue(@NonNull String name,
 @Nullable Message defaultValue)

size

public int size()

Returns:

The list size, should only be used in combination with iterator()!

getValue

public ParameterValue getValue(int i)

Returns:

The corresponding ParameterValue, should only be used in combination with iterator()!

iterator

public @NonNull Iterator<ParameterValue> iterator()

Returns the List iterator which may contain Parameters with the same name!

Specified by:

iterator in interface Iterable<ParameterValue>

stream

public Stream<ParameterValue> stream()