org.wildfly.discovery

Class FilterSpec

java.lang.Object

org.wildfly.discovery.FilterSpec

All Implemented Interfaces:

Serializable

public abstract class FilterSpec
extends Object
implements Serializable

A filter specification for matching attributes.

Author:

David M. Lloyd

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
static FilterSpec	all(Collection<FilterSpec> specs) Create a filter which matches all of the given sub-filters.
static FilterSpec	all(FilterSpec... specs) Create a filter which matches all of the given sub-filters.
static FilterSpec	any(Collection<FilterSpec> specs) Create a filter which matches any of the given sub-filters.
static FilterSpec	any(FilterSpec... specs) Create a filter which matches any of the given sub-filters.
static FilterSpec	approx(String attribute, String value) Create a filter specification which approximately matches one attribute value.
static FilterSpec	equal(String attribute, byte[] value) Create a filter specification which matches one attribute value.
static FilterSpec	equal(String attribute, String value) Create a filter specification which matches one attribute value.
static String	escape(String str) Escape an attribute string, suitable for putting into a filter.
static void	escapeTo(String str, StringBuilder b) Escape an attribute string, suitable for putting into a filter.
static FilterSpec	fromString(String string) Create a new filter from a string.
static FilterSpec	greaterOrEqual(String attribute, byte[] value) Create a filter specification which matches when the given attribute's value is lexicographically greater than or equal to the given value.
static FilterSpec	greaterOrEqual(String attribute, String value) Create a filter specification which matches when the given attribute's value is lexicographically greater than or equal to the given value.
static FilterSpec	hasAttribute(String attribute) Create a filter specification which matches when the given attribute is present.
static FilterSpec	lessOrEqual(String attribute, byte[] value) Create a filter specification which matches when the given attribute's value is lexicographically less than or equal to the given value.
static FilterSpec	lessOrEqual(String attribute, String value) Create a filter specification which matches when the given attribute's value is lexicographically less than or equal to the given value.
abstract boolean	matchesMulti(Map<String,? extends Collection<AttributeValue>> attributes) Determine whether the given attribute multi-map matches this filter.
abstract boolean	matchesSimple(Map<String,AttributeValue> attributes) Determine whether the given simple attribute map matches this filter.
static FilterSpec	not(FilterSpec spec) Create a filter which matches the inverse of the given filter.
static FilterSpec	substringMatch(String attribute, String initialPart, String finalPart) Create a filter specification which matches a leading or trailing (or both) substring of one attribute value.
String	toString() Get the string representation of this filter.

Methods inherited from class java.lang.Object

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

Method Detail

matchesSimple

public abstract boolean matchesSimple(Map<String,AttributeValue> attributes)

Determine whether the given simple attribute map matches this filter.

Parameters:

attributes - the attribute map

Returns:

true if the map matches, false otherwise

matchesMulti

public abstract boolean matchesMulti(Map<String,? extends Collection<AttributeValue>> attributes)

Determine whether the given attribute multi-map matches this filter.

Parameters:

attributes - the attribute map

Returns:

true if the map matches, false otherwise

fromString

public static FilterSpec fromString(String string)

Create a new filter from a string.

Parameters:

string - the filter string

Returns:

the filter specification

all

public static FilterSpec all(FilterSpec... specs)

Create a filter which matches all of the given sub-filters.

Parameters:

specs - the sub-filters

Returns:

the filter specification

all

public static FilterSpec all(Collection<FilterSpec> specs)

Create a filter which matches all of the given sub-filters.

Parameters:

specs - the sub-filters

Returns:

the filter specification

any

public static FilterSpec any(FilterSpec... specs)

Create a filter which matches any of the given sub-filters.

Parameters:

specs - the sub-filters

Returns:

the filter specification

any

public static FilterSpec any(Collection<FilterSpec> specs)

Create a filter which matches any of the given sub-filters.

Parameters:

specs - the sub-filters

Returns:

the filter specification

not

public static FilterSpec not(FilterSpec spec)

Create a filter which matches the inverse of the given filter.

Parameters:

spec - the sub-filter

Returns:

the filter specification

equal

public static FilterSpec equal(String attribute,
                               String value)

Create a filter specification which matches one attribute value.

Parameters:

attribute - the attribute name

value - the attribute value

Returns:

the filter specification

equal

public static FilterSpec equal(String attribute,
                               byte[] value)

Create a filter specification which matches one attribute value.

Parameters:

attribute - the attribute name

value - the attribute byte value

Returns:

the filter specification

substringMatch

public static FilterSpec substringMatch(String attribute,
                                        String initialPart,
                                        String finalPart)

Create a filter specification which matches a leading or trailing (or both) substring of one attribute value.

Parameters:

attribute - the attribute name

initialPart - the initial part, or "" to match any initial part

finalPart - the final part, or "" to match any final part

Returns:

the filter specification

approx

public static FilterSpec approx(String attribute,
                                String value)

Create a filter specification which approximately matches one attribute value.

Parameters:

attribute - the attribute name

value - the attribute value

Returns:

the filter specification

greaterOrEqual

public static FilterSpec greaterOrEqual(String attribute,
                                        String value)

Create a filter specification which matches when the given attribute's value is lexicographically greater than or equal to the given value.

Parameters:

attribute - the attribute name

value - the attribute value

Returns:

the filter specification

greaterOrEqual

public static FilterSpec greaterOrEqual(String attribute,
                                        byte[] value)

Create a filter specification which matches when the given attribute's value is lexicographically greater than or equal to the given value.

Parameters:

attribute - the attribute name

value - the attribute value

Returns:

the filter specification

lessOrEqual

public static FilterSpec lessOrEqual(String attribute,
                                     String value)

Create a filter specification which matches when the given attribute's value is lexicographically less than or equal to the given value.

Parameters:

attribute - the attribute name

value - the attribute value

Returns:

the filter specification

lessOrEqual

public static FilterSpec lessOrEqual(String attribute,
                                     byte[] value)

Create a filter specification which matches when the given attribute's value is lexicographically less than or equal to the given value.

Parameters:

attribute - the attribute name

value - the attribute value

Returns:

the filter specification

hasAttribute

public static FilterSpec hasAttribute(String attribute)

Create a filter specification which matches when the given attribute is present.

Parameters:

attribute - the attribute name

Returns:

the filter specification

escape

public static String escape(String str)

Escape an attribute string, suitable for putting into a filter.

Parameters:

str - the string to escape

Returns:

the escaped string

escapeTo

public static void escapeTo(String str,
                            StringBuilder b)

Escape an attribute string, suitable for putting into a filter.

Parameters:

str - the string to escape

b - the builder to append to

toString

public final String toString()

Get the string representation of this filter.

Overrides:

toString in class Object

Returns:

the string representation of this filter