com.sun.xacml
Class MatchResult

java.lang.Object
  com.sun.xacml.MatchResult

public class MatchResult

extends Object

This is used as the return value for the various target matching functions. It communicates that either the target matches the input request, the target doesn't match the input request, or the result is Indeterminate.

Since:

1.0

Field Summary

static int	INDETERMINATE An integer value indicating the the result is Indeterminate
static int	MATCH An integer value indicating the the target matches the request
static int	NO_MATCH An integer value indicating that the target doesn't match the request

Constructor Summary

MatchResult(int result)
Constructor that creates a MatchResult with no Status

MatchResult(int result, Status status)
Constructor that creates a MatchResult, including Status data

Method Summary

int	getResult() Returns the applicable result
Status	getStatus() Returns the status if there was an error, or null if no error occurred

Methods inherited from class java.lang.Object

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

Field Detail

MATCH

public static final int MATCH

An integer value indicating the the target matches the request

See Also:

Constant Field Values

NO_MATCH

public static final int NO_MATCH

An integer value indicating that the target doesn't match the request

See Also:

Constant Field Values

INDETERMINATE

public static final int INDETERMINATE

An integer value indicating the the result is Indeterminate

See Also:

Constant Field Values

Constructor Detail

MatchResult

public MatchResult(int result)

Constructor that creates a MatchResult with no Status

Parameters:

result - the applicable result

MatchResult

public MatchResult(int result,
                   Status status)
            throws IllegalArgumentException

Constructor that creates a MatchResult, including Status data

Parameters:

result - the applicable result

status - the error information

Throws:

IllegalArgumentException - if the input result isn't a valid value

Method Detail

getResult

public int getResult()

Returns the applicable result

Returns:

the applicable result

getStatus

public Status getStatus()

Returns the status if there was an error, or null if no error occurred

Returns:

the error status data or null