Package org.opendaylight.yangtools.yang.xpath.api

Interface YangXPathMathSupport

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractYangXPathMathSupport

public interface YangXPathMathSupport
extends Serializable

Interface supporting mathematical operations. This interface should be implemented by subclassing AbstractYangXPathMathSupport, which provides type safety guards.

Method Summary

Modifier and Type	Method	Description
YangNumberExpr	createNumber(int value)	Create a YangNumberExpr for specified integer.
YangNumberExpr	createNumber(String str)	Create a YangNumberExpr backed by specified string.
YangNumberExpr	negateNumber(YangNumberExpr number)	Create a YangNumberExpr representing the negated value of a number.
Optional<YangExpr>	tryEvaluate(YangBinaryOperator operator, YangNumberExpr left, YangNumberExpr right)	Attempt to evaluate an operator and its left- and right-handside.

Method Details

createNumber

YangNumberExpr createNumber(String str)

Create a YangNumberExpr backed by specified string.

Parameters:

str - String

Returns:

number expression

Throws:

NullPointerException - if str is null

NumberFormatException - if the string does not represent a valid number

createNumber

YangNumberExpr createNumber(int value)

Create a YangNumberExpr for specified integer.

Parameters:

value - integer value

Returns:

number expression

negateNumber

YangNumberExpr negateNumber(YangNumberExpr number)

Create a YangNumberExpr representing the negated value of a number.

Parameters:

number - input number

Returns:

negated number expression

Throws:

NullPointerException - if number is null

IllegalArgumentException - if number has unrecognized type

tryEvaluate

Optional<YangExpr> tryEvaluate(YangBinaryOperator operator,
 YangNumberExpr left,
 YangNumberExpr right)

Attempt to evaluate an operator and its left- and right-handside.

Parameters:

operator - Operator to apply

left - Left hand-side

right - Right hand-side

Returns:

Evaluation result, if evaluation succeeded

Throws:

NullPointerException - if any of the arguments is null