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

java.lang.Object
  de.lmu.ifi.dbs.elki.logging.AbstractLoggable
      de.lmu.ifi.dbs.elki.utilities.optionhandling.constraints.AllOrNoneMustBeSetGlobalConstraint

All Implemented Interfaces:

Loggable, GlobalParameterConstraint

public class AllOrNoneMustBeSetGlobalConstraint
extends AbstractLoggable
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

private List<Parameter<?,?>>

parameterList List of parameters to be checked

Fields inherited from class de.lmu.ifi.dbs.elki.logging.AbstractLoggable

debug

Constructor Summary

AllOrNoneMustBeSetGlobalConstraint(List<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

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 de.lmu.ifi.dbs.elki.logging.AbstractLoggable

debugFine, debugFiner, debugFinest, exception, message, progress, progress, progress, verbose, verbose, warning

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.lmu.ifi.dbs.elki.logging.Loggable

debugFine, debugFiner, debugFinest, exception, message, progress, progress, verbose, verbose, warning

Field Detail

parameterList

private List<Parameter<?,?>> parameterList

List of parameters to be checked

Constructor Detail

AllOrNoneMustBeSetGlobalConstraint

public AllOrNoneMustBeSetGlobalConstraint(List<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.

See Also:

GlobalParameterConstraint.test()

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

See Also:

GlobalParameterConstraint.getDescription()