org.onosproject.pce.pceservice.constraint

Class CostConstraint

java.lang.Object

org.onosproject.pce.pceservice.constraint.CostConstraint

All Implemented Interfaces:

Constraint

public final class CostConstraint
extends Object
implements Constraint

Constraint that evaluates whether cost for a link is available, if yes return cost for that link.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CostConstraint.Type Represents about cost types.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COST
static String	TE_COST

Constructor Summary

Constructors

Constructor and Description
CostConstraint(CostConstraint.Type type) Creates a new cost constraint.

Method Summary

Modifier and Type	Method and Description
double	cost(Link link, ResourceContext context) Evaluates the specified link and provides the cost for its traversal.
boolean	equals(Object obj)
int	hashCode()
static CostConstraint	of(CostConstraint.Type type) Creates new CostConstraint with specified cost type.
String	toString()
CostConstraint.Type	type() Returns the type of a cost specified in a constraint.
boolean	validate(Path path, ResourceContext context) Validates that the specified path satisfies the constraint.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

TE_COST

public static final String TE_COST

See Also:

Constant Field Values

COST

public static final String COST

See Also:

Constant Field Values

Constructor Detail

CostConstraint

public CostConstraint(CostConstraint.Type type)

Creates a new cost constraint.

Parameters:

type - of a link

Method Detail

of

public static CostConstraint of(CostConstraint.Type type)

Creates new CostConstraint with specified cost type.

Parameters:

type - of cost

Returns:

instance of CostConstraint

type

public CostConstraint.Type type()

Returns the type of a cost specified in a constraint.

Returns:

required cost type

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

cost

public double cost(Link link,
                   ResourceContext context)

Description copied from interface: Constraint

Evaluates the specified link and provides the cost for its traversal.

Specified by:

cost in interface Constraint

Parameters:

link - link to be evaluated

context - resource context for validating availability of resources

Returns:

cost of link traversal

validate

public boolean validate(Path path,
                        ResourceContext context)

Description copied from interface: Constraint

Validates that the specified path satisfies the constraint.

Specified by:

validate in interface Constraint

Parameters:

path - path to be validated

context - resource context for validating availability of resources

Returns:

cost of link traversal