de.lmu.ifi.dbs.elki.utilities.optionhandling.constraints

Class AllOrNoneMustBeSetGlobalConstraint

java.lang.Object

de.lmu.ifi.dbs.elki.utilities.optionhandling.constraints.AllOrNoneMustBeSetGlobalConstraint

All Implemented Interfaces:

GlobalParameterConstraint

public class AllOrNoneMustBeSetGlobalConstraint
extends Object
implements GlobalParameterConstraint

Global parameter constraint specifying that either all elements of a list of parameters (Parameter) must be set, or none of them.

Author:

Steffi Wanka

Field Summary

Fields

Modifier and Type	Field and Description
private Parameter<?>[]	parameterList List of parameters to be checked

Constructor Summary

Constructors

Constructor and Description
AllOrNoneMustBeSetGlobalConstraint(Parameter<?>... parameters) Constructs a global parameter constraint for testing if either all elements of a list of parameters are set or none of them.

Method Summary

Modifier and Type	Method and Description
String	getDescription() Returns a description of this global constraint.
void	test() Checks if either all elements of a list of parameters are set, or none of them.

Methods inherited from class java.lang.Object

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

Field Detail

parameterList

private Parameter<?>[] parameterList

List of parameters to be checked

Constructor Detail

AllOrNoneMustBeSetGlobalConstraint

public AllOrNoneMustBeSetGlobalConstraint(Parameter<?>... parameters)

Constructs a global parameter constraint for testing if either all elements of a list of parameters are set or none of them.

Parameters:

parameters - list of parameters to be checked

Method Detail

test

public void test()
          throws ParameterException

Checks if either all elements of a list of parameters are set, or none of them. If not, a parameter exception is thrown.

Specified by:

test in interface GlobalParameterConstraint

Throws:

ParameterException - if the parameters don't satisfy the parameter constraint.

getDescription

public String getDescription()

Description copied from interface: GlobalParameterConstraint

Returns a description of this global constraint.

Specified by:

getDescription in interface GlobalParameterConstraint

Returns:

a description of this global constraint