com.yahoo.jdisc.application

Class BindingMatch<T>

java.lang.Object

com.yahoo.jdisc.application.BindingMatch<T>

Type Parameters:

T - The class of the target.

public class BindingMatch<T>
extends Object

This class holds the result of a BindingSet.match(URI) operation. It contains methods to inspect the groups captured during matching, where a group is defined as a sequence of characters matches by a wildcard in the UriPattern, and to retrieve the matched target.

Constructor Summary

Constructors

Constructor and Description
BindingMatch(UriPattern.Match match, T target) Deprecated. use BindingMatch(UriPattern.Match match, T target, UriPattern matched)
BindingMatch(UriPattern.Match match, T target, UriPattern matched) Constructs a new instance of this class.

Method Summary

Modifier and Type	Method and Description
String	group(int idx) Returns the input subsequence captured by the given group by this match.
int	groupCount() Returns the number of captured groups of this match.
UriPattern	matched() Returns the URI pattern that was matched.
T	target() Returns the matched target.

Methods inherited from class java.lang.Object

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

Constructor Detail

BindingMatch

@Deprecated
public BindingMatch(UriPattern.Match match,
                                T target)

Deprecated. use BindingMatch(UriPattern.Match match, T target, UriPattern matched)

Constructs a new instance of this class.

Parameters:

match - The match information for this instance.

target - The target of this match.

Throws:

NullPointerException - If any argument is null.

BindingMatch

public BindingMatch(UriPattern.Match match,
                    T target,
                    UriPattern matched)

Constructs a new instance of this class.

Parameters:

match - The match information for this instance.

target - The target of this match.

matched - The matched URI pattern

Throws:

NullPointerException - If any argument is null.

Method Detail

groupCount

public int groupCount()

Returns the number of captured groups of this match. Any non-negative integer smaller than the value returned by this method is a valid group index for this match.

Returns:

The number of captured groups.

group

public String group(int idx)

Returns the input subsequence captured by the given group by this match. Groups are indexed from left to right, starting at zero. Note that some groups may match an empty string, in which case this method returns the empty string. This method never returns null.

Parameters:

idx - The index of the group to return.

Returns:

The (possibly empty) substring captured by the group during matching, never null.

Throws:

IndexOutOfBoundsException - If there is no group in the match with the given index.

target

public T target()

Returns the matched target.

Returns:

The matched target.

matched

public UriPattern matched()

Returns the URI pattern that was matched.

Returns:

The matched pattern.