net.roboconf.dm.templating.internal.helpers

Class InstanceFilter

java.lang.Object

net.roboconf.dm.templating.internal.helpers.InstanceFilter

public final class InstanceFilter
extends Object

An instance filter based on a component path and/or an installer name.

This filter is used in the all Handlebars template helper.

Author:

Pierre Bourret - Université Joseph Fourier

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALTERNATIVE
static String	JOKER
static String	PATH_SEPARATOR

Method Summary

Modifier and Type	Method and Description
Collection<InstanceContextBean>	apply(Collection<InstanceContextBean> instances) Applies this filter to the given instances.
static InstanceFilter	createFilter(String path, String installerName) Factory for Filters.
String	getPath() Gets the path string of this filter.

Methods inherited from class java.lang.Object

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

Field Detail

JOKER

public static final String JOKER

See Also:

Constant Field Values

PATH_SEPARATOR

public static final String PATH_SEPARATOR

See Also:

Constant Field Values

ALTERNATIVE

public static final String ALTERNATIVE

See Also:

Constant Field Values

Method Detail

createFilter

public static InstanceFilter createFilter(String path,
                                          String installerName)

Factory for Filters.

Parameters:

path - component path for the filter to be created (neither null, nor empty)

installerName -

Returns:

the created filter

Throws:

IllegalArgumentException - if path is an illegal component path

apply

public Collection<InstanceContextBean> apply(Collection<InstanceContextBean> instances)

Applies this filter to the given instances.

Parameters:

instances - the collection of instances to which this filter has to be applied.

Returns:

the instances of the provided collection that matches this filter.

getPath

public String getPath()

Gets the path string of this filter.

Returns:

the path string of this filter.