com.googlecode.jbp.common.requirements
Class ParamRequirements

java.lang.Object
  com.googlecode.jbp.common.requirements.AbstractRequirements
      com.googlecode.jbp.common.requirements.ParamRequirements

All Implemented Interfaces:

IRequirements

public final class ParamRequirements
extends AbstractRequirements

Provides useful methods to check for method parameter validity.

Unless explicitly stated, these methods throw an java.lang.IllegalArgumentException if the parameter is not valid.

Example of null parameter check: ParamRequirements.INSTANCE.requireNotNull(firstParameter); instead of if (firstParameter == null) { throw new IllegalArgumentException("First parameter must not be null."); }

Author:

Yannick LOTH - yannick AT littlej.biz -

Field Summary

static ParamRequirements

INSTANCE Singleton instance.

Method Summary

protected void

onConditionNotMet(String messageParam) Called if a condition is not met.

Methods inherited from class com.googlecode.jbp.common.requirements.AbstractRequirements

requireAllInstanceOf, requireConjunction, requireDirectory, requireDirectory, requireDisjunction, requireExclusiveDisjunction, requireExistingFile, requireExistingFile, requireFalse, requireFutureInstant, requireFutureInstant, requireInstanceOf, requireNotAllSimultaneouslyNull, requireNotAllSimultaneouslyNull, requireNotBlank, requireNotEmpty, requireNotExistingFile, requireNotExistingFile, requireNotNegative, requireNotNegativeNorZero, requireNotNull, requireNotPositive, requireNotPositiveNorZero, requireNotZero, requireNull, requirePastInstant, requirePastInstant, requireTrue

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final ParamRequirements INSTANCE

Singleton instance.

Method Detail

onConditionNotMet

protected void onConditionNotMet(String messageParam)

Description copied from class: AbstractRequirements

Called if a condition is not met. Usually throws a RequirementException.

Specified by:

onConditionNotMet in class AbstractRequirements

Parameters:

messageParam - The associated message.