org.bitbucket.cowwoc.requirements.guava.GuavaVerifiers Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of requirements-guava Show documentation

There is a newer version: 4.0.4-RC

/*
 * Copyright 2017 Gili Tzabari.
 * Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0
 */
package org.bitbucket.cowwoc.requirements.guava;

import com.google.common.collect.Multimap;
import org.bitbucket.cowwoc.requirements.core.Configurable;
import org.bitbucket.cowwoc.requirements.core.Configuration;

/**
 * An entry point for verifying API requirements.
 * 
 * Unlike {@link Requirements}, instances of this interface are configurable.
 * 
 * Implementations must be immutable.
 *
 * @since 3.0.0
 * @author Gili Tzabari
 */
public interface GuavaVerifiers extends Configurable
{
	@Override
	GuavaVerifiers addContext(String key, Object value);

	@Override
	GuavaVerifiers withDefaultException();

	@Override
	GuavaVerifiers withException(Class exception);

	@Override
	GuavaVerifiers withAssertionsDisabled();

	@Override
	GuavaVerifiers withAssertionsEnabled();

	@Override
	boolean assertionsAreEnabled();

	@Override
	GuavaVerifiers withConfiguration(Configuration configuration);

	/**
	 * Verifies a {@code Multimap}.
	 *
	 * @param     the type of key in the multimap
	 * @param     the type of value in the multimap
	 * @param actual the actual value
	 * @param name   the name of the value
	 * @return a verifier for the value
	 * @throws NullPointerException     if {@code name} is null
	 * @throws IllegalArgumentException if {@code name} is empty
	 */
	 MultimapVerifier requireThat(Multimap actual, String name);

	/**
	 * Same as {@link #requireThat(Multimap, String)} but does nothing if assertions are disabled.
	 *
	 * @param     the type of key in the multimap
	 * @param     the type of value in the multimap
	 * @param actual the actual value
	 * @param name   the name of the value
	 * @return a verifier for the value
	 * @throws NullPointerException     if name is null
	 * @throws IllegalArgumentException if name is empty
	 */
	 MultimapVerifier assertThat(Multimap actual, String name);
}