org.gradle.util

Class NameMatcher

java.lang.Object

org.gradle.util.NameMatcher

public class NameMatcher
extends Object

Selects a single item from a list of candidates based on a camel-case pattern.

Constructor Summary

Constructors

Constructor and Description
NameMatcher()

Method Summary

Methods

Modifier and Type	Method and Description
String	find(String pattern, Collection<String> items) Locates the best match for the given pattern in the given set of candidate items.
<T> T	find(String pattern, Map<String,? extends T> items) Locates the best match for the given pattern in the given set of candidate items.
String	formatErrorMessage(String singularItemDescription, Object container)
Set<String>	getCandidates() Returns the potential matches, if any.
Set<String>	getMatches() Returns all matches, when there were more than 1.

Methods inherited from class java.lang.Object

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

Constructor Detail

NameMatcher

public NameMatcher()

Method Detail

find

public <T> T find(String pattern,
         Map<String,? extends T> items)

Locates the best match for the given pattern in the given set of candidate items.

Returns:

The matching item if exactly 1 match found, null if no matches or multiple matches.

find

public String find(String pattern,
          Collection<String> items)

Locates the best match for the given pattern in the given set of candidate items.

Returns:

The match if exactly 1 match found, null if no matches or multiple matches.

getMatches

public Set<String> getMatches()

Returns all matches, when there were more than 1.

Returns:

The matches. Returns an empty set when there are no matches.

getCandidates

public Set<String> getCandidates()

Returns the potential matches, if any.

Returns:

The matches. Returns an empty set when there are no potential matches.

formatErrorMessage

public String formatErrorMessage(String singularItemDescription,
                        Object container)