org.btrplace.btrpsl.constraint

Class OneOfParam

java.lang.Object

org.btrplace.btrpsl.constraint.DefaultConstraintParam<Object>

org.btrplace.btrpsl.constraint.OneOfParam

All Implemented Interfaces:

ConstraintParam<Object>

public class OneOfParam
extends DefaultConstraintParam<Object>

A parameter for a constraint that can have multiple arguments types.

Author:

Vincent Kherbache

Field Summary

Fields

Modifier and Type	Field and Description
protected List<ConstraintParam<?>>	paramsList

Constructor Summary

Constructors

Constructor and Description
OneOfParam(String n, ConstraintParam<?>... params) Make a new multiple types parameter.

Method Summary

Modifier and Type	Method and Description
String	fullSignature() Get the signature of the parameter including the parameter name.
boolean	isCompatibleWith(BtrPlaceTree t, BtrpOperand o) Check if a given operand is compatible with this parameter.
String	prettySignature() Get the signature of the parameter without the parameter name.
Object	transform(SatConstraintBuilder cb, BtrPlaceTree tree, BtrpOperand op) Transform an operand into the right btrplace parameter.

Methods inherited from class org.btrplace.btrpsl.constraint.DefaultConstraintParam

getName

Methods inherited from class java.lang.Object

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

Field Detail

paramsList

protected List<ConstraintParam<?>> paramsList

Constructor Detail

OneOfParam

public OneOfParam(String n,
                  ConstraintParam<?>... params)

Make a new multiple types parameter.

Parameters:

n - the parameter name

params - the list of different parameters types

Method Detail

prettySignature

public String prettySignature()

Description copied from interface: ConstraintParam

Get the signature of the parameter without the parameter name.

Specified by:

prettySignature in interface ConstraintParam<Object>

Overrides:

prettySignature in class DefaultConstraintParam<Object>

Returns:

a non-empty string

fullSignature

public String fullSignature()

Description copied from interface: ConstraintParam

Get the signature of the parameter including the parameter name.

Specified by:

fullSignature in interface ConstraintParam<Object>

Overrides:

fullSignature in class DefaultConstraintParam<Object>

Returns:

a non-empty string

transform

public Object transform(SatConstraintBuilder cb,
                        BtrPlaceTree tree,
                        BtrpOperand op)

Description copied from interface: ConstraintParam

Transform an operand into the right btrplace parameter.

Parameters:

cb - the associated constraint

tree - the tree use to propagate errors

op - the operand to transform

Returns:

the transformed parameter. null if the transformation is not possible

isCompatibleWith

public boolean isCompatibleWith(BtrPlaceTree t,
                                BtrpOperand o)

Description copied from interface: ConstraintParam

Check if a given operand is compatible with this parameter.

Parameters:

t - the tree used to propagate errors

o - the operand to test

Returns:

true iff the operand is compatible