Index (Requirements 2.0.0 API)

A B C D E F G I K L M N O P R S T U V W

A

Assertions - Class in org.bitbucket.cowwoc.requirements: Verifies requirements of a parameter if assertions are enabled; otherwise, does nothing.
Assertions(boolean) - Constructor for class org.bitbucket.cowwoc.requirements.Assertions: Creates a new assertion.
assertThat(Object, String) - Static method in class org.bitbucket.cowwoc.requirements.Requirements: Same as Requirements.requireThat(Object, String) but does nothing if assertions are disabled for this class.
assertThat(Collection<E>, String) - Static method in class org.bitbucket.cowwoc.requirements.Requirements: Same as Requirements.requireThat(Collection, String) but does nothing if assertions are disabled for this class.
assertThat(T, String) - Static method in class org.bitbucket.cowwoc.requirements.Requirements: Same as Requirements.requireThat(Comparable, String) but does nothing if assertions are disabled for this class.
assertThat(T, String) - Static method in class org.bitbucket.cowwoc.requirements.Requirements: Same as Requirements.requireThat(Number, String) but does nothing if assertions are disabled for this class.
assertThat(BigDecimal, String) - Static method in class org.bitbucket.cowwoc.requirements.Requirements: Same as Requirements.requireThat(BigDecimal, String) but does nothing if assertions are disabled for this class.
assertThat(Map<K, V>, String) - Static method in class org.bitbucket.cowwoc.requirements.Requirements: Same as Requirements.requireThat(Map, String) but does nothing if assertions are disabled for this class.
assertThat(Path, String) - Static method in class org.bitbucket.cowwoc.requirements.Requirements: Same as Requirements.requireThat(Path, String) but does nothing if assertions are disabled for this class.
assertThat(String, String) - Static method in class org.bitbucket.cowwoc.requirements.Requirements: Same as Requirements.requireThat(String, String) but does nothing if assertions are disabled for this class.
assertThat(URI, String) - Static method in class org.bitbucket.cowwoc.requirements.Requirements: Same as Requirements.requireThat(URI, String) but does nothing if assertions are disabled for this class.
assertThat(Class<T>, String) - Static method in class org.bitbucket.cowwoc.requirements.Requirements: Same as Requirements.requireThat(Class, String) but does nothing if assertions are disabled for this class.
assertThat(Optional<?>, String) - Static method in class org.bitbucket.cowwoc.requirements.Requirements: Same as Requirements.requireThat(Optional, String) but does nothing if assertions are disabled for this class.

B

BigDecimalPrecisionRequirements - Interface in org.bitbucket.cowwoc.requirements: Verifies requirements of a BigDecimal.precision().
BigDecimalRequirements - Interface in org.bitbucket.cowwoc.requirements: Verifies requirements of a BigDecimal parameter.
BigDecimalScaleRequirements - Interface in org.bitbucket.cowwoc.requirements: Verifies requirements of a BigDecimal.scale().

C

ClassRequirements<T> - Interface in org.bitbucket.cowwoc.requirements: Verifies requirements of a Class parameter.
CollectionRequirements<E> - Interface in org.bitbucket.cowwoc.requirements: Verifies requirements of a Collection parameter.
CollectionRequirementsSpi<S extends CollectionRequirementsSpi<S,E>,E> - Interface in org.bitbucket.cowwoc.requirements.spi: Verifies requirements of a Collection parameter.
CollectionSizeRequirements - Interface in org.bitbucket.cowwoc.requirements: Verifies requirements of a Collection.size().
ComparableRequirements<T extends Comparable<? super T>> - Interface in org.bitbucket.cowwoc.requirements: Verifies requirements of a Comparable.
ComparableRequirementsSpi<S extends ComparableRequirementsSpi<S,T>,T extends Comparable<? super T>> - Interface in org.bitbucket.cowwoc.requirements.spi: Verifies requirements of a Comparable.
Configuration - Class in org.bitbucket.cowwoc.requirements.spi: Determines the behavior of a requirements verifier.
Configuration(Class<? extends RuntimeException>, Map<String, Object>) - Constructor for class org.bitbucket.cowwoc.requirements.spi.Configuration: Creates a new instance.
contains(E) - Method in interface org.bitbucket.cowwoc.requirements.spi.CollectionRequirementsSpi: Ensures that the parameter contains an element.
contains(E, String) - Method in interface org.bitbucket.cowwoc.requirements.spi.CollectionRequirementsSpi: Ensures that the parameter contains an element.
containsAll(Collection<E>) - Method in interface org.bitbucket.cowwoc.requirements.spi.CollectionRequirementsSpi: Ensures that the parameter contains all of multiple elements.
containsAll(Collection<E>, String) - Method in interface org.bitbucket.cowwoc.requirements.spi.CollectionRequirementsSpi: Ensures that the parameter contains all of multiple elements.
containsAny(Collection<E>) - Method in interface org.bitbucket.cowwoc.requirements.spi.CollectionRequirementsSpi: Ensures that the parameter contains any of multiple elements.
containsAny(Collection<E>, String) - Method in interface org.bitbucket.cowwoc.requirements.spi.CollectionRequirementsSpi: Ensures that the parameter contains any of multiple elements.
containsExactly(Collection<E>) - Method in interface org.bitbucket.cowwoc.requirements.spi.CollectionRequirementsSpi: Ensures that the parameter contains exactly the specified elements; nothing less, nothing more.
containsExactly(Collection<E>, String) - Method in interface org.bitbucket.cowwoc.requirements.spi.CollectionRequirementsSpi: Ensures that the parameter contains exactly the specified elements; nothing less, nothing more.
createException(Class<E>, String) - Method in class org.bitbucket.cowwoc.requirements.spi.Configuration: Creates a new exception.
createException(Class<E>, String, Throwable) - Method in class org.bitbucket.cowwoc.requirements.spi.Configuration: Creates a new exception.
createException(Class<E>, String, String, Object) - Method in class org.bitbucket.cowwoc.requirements.spi.Configuration: Creates a new exception.
createException(Class<E>, String, String, Object, Throwable) - Method in class org.bitbucket.cowwoc.requirements.spi.Configuration: Creates a new exception.
createException(Class<E>, String, String, Object, String, Object) - Method in class org.bitbucket.cowwoc.requirements.spi.Configuration: Creates a new exception.
createException(Class<E>, String, String, Object, String, Object, Throwable) - Method in class org.bitbucket.cowwoc.requirements.spi.Configuration: Creates a new exception.
createException(Class<E>, String, String, Object, String, Object, String, Object) - Method in class org.bitbucket.cowwoc.requirements.spi.Configuration: Creates a new exception.
createException(Class<E>, String, String, Object, String, Object, String, Object, Throwable) - Method in class org.bitbucket.cowwoc.requirements.spi.Configuration: Creates a new exception.
createException(Class<E>, String, String, Object, String, Object, String, Object, String, Object) - Method in class org.bitbucket.cowwoc.requirements.spi.Configuration: Creates a new exception.
createException(Class<E>, String, String, Object, String, Object, String, Object, String, Object, Throwable) - Method in class org.bitbucket.cowwoc.requirements.spi.Configuration: Creates a new exception.
createException(Class<E>, String, Map<String, Object>, Throwable) - Method in class org.bitbucket.cowwoc.requirements.spi.Configuration: Creates a new exception.
createException(Class<E>, String, Throwable) - Static method in class org.bitbucket.cowwoc.requirements.util.Exceptions: Throws an exception with the specified message and cause.

D

doesNotContain(E) - Method in interface org.bitbucket.cowwoc.requirements.spi.CollectionRequirementsSpi: Ensures that the parameter does not contain an element.
doesNotContain(E, String) - Method in interface org.bitbucket.cowwoc.requirements.spi.CollectionRequirementsSpi: Ensures that the parameter does not contain an element.
doesNotContainAll(Collection<E>) - Method in interface org.bitbucket.cowwoc.requirements.spi.CollectionRequirementsSpi: Ensures that the parameter does not contain all of multiple elements.
doesNotContainAll(Collection<E>, String) - Method in interface org.bitbucket.cowwoc.requirements.spi.CollectionRequirementsSpi: Ensures that the parameter does not contain all of multiple elements.
doesNotContainAny(Collection<E>) - Method in interface org.bitbucket.cowwoc.requirements.spi.CollectionRequirementsSpi: Ensures that the parameter does not contain any of multiple elements.
doesNotContainAny(Collection<E>, String) - Method in interface org.bitbucket.cowwoc.requirements.spi.CollectionRequirementsSpi: Ensures that the parameter does not contain any of multiple elements.
doesNotContainDuplicates() - Method in interface org.bitbucket.cowwoc.requirements.spi.CollectionRequirementsSpi: Ensures that the parameter does not contain any duplicate elements.
doesNotEndWith(String) - Method in interface org.bitbucket.cowwoc.requirements.StringRequirements: Ensures that the parameter does not end with a value.
doesNotStartWith(String) - Method in interface org.bitbucket.cowwoc.requirements.StringRequirements: Ensures that the parameter does not start with a value.

E

endsWith(String) - Method in interface org.bitbucket.cowwoc.requirements.StringRequirements: Ensures that the parameter ends with a value.
entrySet() - Method in interface org.bitbucket.cowwoc.requirements.MapRequirements
Exceptions - Class in org.bitbucket.cowwoc.requirements.util: Exception helper functions.
exists() - Method in interface org.bitbucket.cowwoc.requirements.PathRequirements: Ensures that a path exists.

F

filterStacktrace(Throwable, Predicate<String>) - Static method in class org.bitbucket.cowwoc.requirements.util.Exceptions: Runs a predicate against all lines of a stacktrace removing lines at or above those that match.

G

getContext() - Method in class org.bitbucket.cowwoc.requirements.spi.Configuration
getExceptionOverride() - Method in class org.bitbucket.cowwoc.requirements.spi.Configuration

I

isAbsolute() - Method in interface org.bitbucket.cowwoc.requirements.PathRequirements: Ensures that a path is absolute.
isAbsolute() - Method in interface org.bitbucket.cowwoc.requirements.UriRequirements: Ensures that the parameter is absolute.
isDirectory(LinkOption...) - Method in interface org.bitbucket.cowwoc.requirements.PathRequirements: Ensures that a path refers to a directory.
isEmailFormat() - Method in interface org.bitbucket.cowwoc.requirements.StringRequirements: Ensures that the parameter contains a valid email format.
isEmpty() - Method in interface org.bitbucket.cowwoc.requirements.MapRequirements: Ensures that the parameter is empty.
isEmpty() - Method in interface org.bitbucket.cowwoc.requirements.OptionalRequirements: Ensures that the parameter is empty.
isEmpty() - Method in interface org.bitbucket.cowwoc.requirements.spi.CollectionRequirementsSpi: Ensures that the parameter is empty.
isEmpty() - Method in interface org.bitbucket.cowwoc.requirements.StringRequirements: Ensures that the parameter is empty.
isEnabled() - Method in class org.bitbucket.cowwoc.requirements.Assertions
isEqualTo(T) - Method in interface org.bitbucket.cowwoc.requirements.spi.ObjectRequirementsSpi: Ensures that the parameter is equal to a value.
isEqualTo(T, String) - Method in interface org.bitbucket.cowwoc.requirements.spi.ObjectRequirementsSpi: Ensures that the parameter is equal to a variable.
isGreaterThan(T, String) - Method in interface org.bitbucket.cowwoc.requirements.spi.ComparableRequirementsSpi: Ensures that the parameter is greater than a variable.
isGreaterThan(T) - Method in interface org.bitbucket.cowwoc.requirements.spi.ComparableRequirementsSpi: Ensures that the parameter is greater than a constant.
isGreaterThanOrEqualTo(T, String) - Method in interface org.bitbucket.cowwoc.requirements.spi.ComparableRequirementsSpi: Ensures that the parameter is greater than or bigger than a variable.
isGreaterThanOrEqualTo(T) - Method in interface org.bitbucket.cowwoc.requirements.spi.ComparableRequirementsSpi: Ensures that the parameter is greater than or bigger than a constant.
isIn(Range<T>) - Method in interface org.bitbucket.cowwoc.requirements.spi.ComparableRequirementsSpi: Ensures that the parameter is within range.
isInstanceOf(Class<?>) - Method in interface org.bitbucket.cowwoc.requirements.spi.ObjectRequirementsSpi: Ensures that the parameter is an instance of a class.
isIpAddressFormat() - Method in interface org.bitbucket.cowwoc.requirements.StringRequirements: Ensures that the parameter contains a valid IP address format.
isLessThan(T, String) - Method in interface org.bitbucket.cowwoc.requirements.spi.ComparableRequirementsSpi: Ensures that the parameter is less than the value of a variable.
isLessThan(T) - Method in interface org.bitbucket.cowwoc.requirements.spi.ComparableRequirementsSpi: Ensures that the parameter is less than a constant.
isLessThanOrEqualTo(T, String) - Method in interface org.bitbucket.cowwoc.requirements.spi.ComparableRequirementsSpi: Ensures that the parameter is less than or equal to a variable.
isLessThanOrEqualTo(T) - Method in interface org.bitbucket.cowwoc.requirements.spi.ComparableRequirementsSpi: Ensures that the parameter is less than or equal to a constant.
isNegative() - Method in interface org.bitbucket.cowwoc.requirements.BigDecimalPrecisionRequirements: Deprecated.
BigDecimal.precision() cannot be negative
isNegative() - Method in interface org.bitbucket.cowwoc.requirements.spi.NumberRequirementsSpi: Ensures that the parameter is negative.
isNotEmpty() - Method in interface org.bitbucket.cowwoc.requirements.MapRequirements: Ensures that the parameter is not empty.
isNotEmpty() - Method in interface org.bitbucket.cowwoc.requirements.spi.CollectionRequirementsSpi: Ensures that the parameter is not empty.
isNotEmpty() - Method in interface org.bitbucket.cowwoc.requirements.StringRequirements: Ensures that the parameter is not empty.
isNotEqualTo(T) - Method in interface org.bitbucket.cowwoc.requirements.spi.ObjectRequirementsSpi: Ensures that the parameter is not equal to a value.
isNotEqualTo(T, String) - Method in interface org.bitbucket.cowwoc.requirements.spi.ObjectRequirementsSpi: Ensures that the parameter is not equal to a variable.
isNotNegative() - Method in interface org.bitbucket.cowwoc.requirements.spi.NumberRequirementsSpi: Ensures that the parameter is not negative.
isNotNull() - Method in interface org.bitbucket.cowwoc.requirements.spi.ObjectRequirementsSpi: Ensures that the parameter is not null.
isNotPositive() - Method in interface org.bitbucket.cowwoc.requirements.BigDecimalPrecisionRequirements: Deprecated.
BigDecimal.precision() cannot be non-positive
isNotPositive() - Method in interface org.bitbucket.cowwoc.requirements.spi.NumberRequirementsSpi: Ensures that the parameter is not positive.
isNotZero() - Method in interface org.bitbucket.cowwoc.requirements.spi.NumberRequirementsSpi: Ensures that the parameter is not zero.
isNull() - Method in interface org.bitbucket.cowwoc.requirements.spi.ObjectRequirementsSpi: Ensures that the parameter is null.
isNull() - Method in interface org.bitbucket.cowwoc.requirements.spi.PrimitiveIntegerRequirementsSpi: Deprecated.
the parameter cannot be null
Isolatable<T> - Interface in org.bitbucket.cowwoc.requirements: Requirements that can be verified in isolation of other instances.
isolate(Consumer<T>) - Method in interface org.bitbucket.cowwoc.requirements.Isolatable: Verifies requirements without modifying the current instance.
isPositive() - Method in interface org.bitbucket.cowwoc.requirements.spi.NumberRequirementsSpi: Ensures that the parameter is positive.
isPresent() - Method in interface org.bitbucket.cowwoc.requirements.OptionalRequirements: Ensures that the parameter is present.
isRegularFile(LinkOption...) - Method in interface org.bitbucket.cowwoc.requirements.PathRequirements: Ensures that a path refers to a regular file.
isRelative() - Method in interface org.bitbucket.cowwoc.requirements.PathRequirements: Ensures that a path is relative.
isSupertypeOf(Class<?>) - Method in interface org.bitbucket.cowwoc.requirements.ClassRequirements: Ensures that the parameter is a superclass or super-interface of a class.
isZero() - Method in interface org.bitbucket.cowwoc.requirements.BigDecimalPrecisionRequirements: Deprecated.
BigDecimal.precision() cannot be zero
isZero() - Method in interface org.bitbucket.cowwoc.requirements.spi.NumberRequirementsSpi: Ensures that the parameter is zero.

K

keySet() - Method in interface org.bitbucket.cowwoc.requirements.MapRequirements

L

length() - Method in interface org.bitbucket.cowwoc.requirements.StringRequirements

M

MapRequirements<K,V> - Interface in org.bitbucket.cowwoc.requirements: Verifies requirements of a Map parameter.
MapSizeRequirements - Interface in org.bitbucket.cowwoc.requirements: Verifies requirements of a Map.size().

N

NumberRequirements<T extends Number & Comparable<? super T>> - Interface in org.bitbucket.cowwoc.requirements: Requirements for a Number.
NumberRequirementsSpi<S extends NumberRequirementsSpi<S,T>,T extends Number & Comparable<? super T>> - Interface in org.bitbucket.cowwoc.requirements.spi: Requirements for a Number.

O

ObjectRequirements<T> - Interface in org.bitbucket.cowwoc.requirements: Verifies requirements of an Object parameter.
ObjectRequirementsSpi<S extends ObjectRequirementsSpi<S,T>,T> - Interface in org.bitbucket.cowwoc.requirements.spi: Verifies requirements of an Object parameter.
OptionalRequirements - Interface in org.bitbucket.cowwoc.requirements: Verifies requirements of an Optional parameter.
org.bitbucket.cowwoc.requirements - package org.bitbucket.cowwoc.requirements: Interfaces in this package are not meant to be extended (because they extend Isolatable), but may be implemented.
org.bitbucket.cowwoc.requirements.spi - package org.bitbucket.cowwoc.requirements.spi: Interfaces in this package are not meant to be implemented (because they do not extend Isolatable), but may be extended.
org.bitbucket.cowwoc.requirements.util - package org.bitbucket.cowwoc.requirements.util

P

PathRequirements - Interface in org.bitbucket.cowwoc.requirements: Verifies requirements of a Path parameter.
precision() - Method in interface org.bitbucket.cowwoc.requirements.BigDecimalRequirements
PrimitiveIntegerRequirementsSpi<S extends PrimitiveIntegerRequirementsSpi<S>> - Interface in org.bitbucket.cowwoc.requirements.spi: Verifies requirements of an int parameter.

R

Requirements - Class in org.bitbucket.cowwoc.requirements: Verifies requirements of a parameter.
requireThat(Object, String) - Method in class org.bitbucket.cowwoc.requirements.Assertions: Same as Requirements.requireThat(Object, String) but does nothing if assertions are disabled.
requireThat(Collection<E>, String) - Method in class org.bitbucket.cowwoc.requirements.Assertions: Same as Requirements.requireThat(Collection, String) but does nothing if assertions are disabled.
requireThat(T, String) - Method in class org.bitbucket.cowwoc.requirements.Assertions: Same as Requirements.requireThat(Comparable, String) but does nothing if assertions are disabled.
requireThat(T, String) - Method in class org.bitbucket.cowwoc.requirements.Assertions: Same as Requirements.requireThat(Number, String) but does nothing if assertions are disabled.
requireThat(BigDecimal, String) - Method in class org.bitbucket.cowwoc.requirements.Assertions: Same as Requirements.requireThat(BigDecimal, String) but does nothing if assertions are disabled.
requireThat(Map<K, V>, String) - Method in class org.bitbucket.cowwoc.requirements.Assertions: Same as Requirements.requireThat(Map, String) but does nothing if assertions are disabled.
requireThat(Path, String) - Method in class org.bitbucket.cowwoc.requirements.Assertions: Same as Requirements.requireThat(Path, String) but does nothing if assertions are disabled.
requireThat(String, String) - Method in class org.bitbucket.cowwoc.requirements.Assertions: Same as Requirements.requireThat(String, String) but does nothing if assertions are disabled.
requireThat(URI, String) - Method in class org.bitbucket.cowwoc.requirements.Assertions: Same as Requirements.requireThat(URI, String) but does nothing if assertions are disabled.
requireThat(Class<T>, String) - Method in class org.bitbucket.cowwoc.requirements.Assertions: Same as Requirements.requireThat(Class, String) but does nothing if assertions are disabled.
requireThat(Optional<?>, String) - Method in class org.bitbucket.cowwoc.requirements.Assertions: Same as Requirements.requireThat(Optional, String) but does nothing if assertions are disabled.
requireThat(Object, String) - Static method in class org.bitbucket.cowwoc.requirements.Requirements: Creates requirements for an Object.
requireThat(Collection<E>, String) - Static method in class org.bitbucket.cowwoc.requirements.Requirements: Creates requirements for a Collection.
requireThat(T, String) - Static method in class org.bitbucket.cowwoc.requirements.Requirements: Creates requirements for a Comparable.
requireThat(T, String) - Static method in class org.bitbucket.cowwoc.requirements.Requirements: Creates requirements for a Number.
requireThat(BigDecimal, String) - Static method in class org.bitbucket.cowwoc.requirements.Requirements: Creates requirements for a BigDecimal.
requireThat(Map<K, V>, String) - Static method in class org.bitbucket.cowwoc.requirements.Requirements: Creates requirements for a Map.
requireThat(Path, String) - Static method in class org.bitbucket.cowwoc.requirements.Requirements: Creates requirements for a Path.
requireThat(String, String) - Static method in class org.bitbucket.cowwoc.requirements.Requirements: Creates requirements for a String.
requireThat(URI, String) - Static method in class org.bitbucket.cowwoc.requirements.Requirements: Creates requirements for a Uri.
requireThat(Class<T>, String) - Static method in class org.bitbucket.cowwoc.requirements.Requirements: Creates requirements for a Class.
requireThat(Optional<?>, String) - Static method in class org.bitbucket.cowwoc.requirements.Requirements: Creates requirements for an Optional.

S

scale() - Method in interface org.bitbucket.cowwoc.requirements.BigDecimalRequirements
size() - Method in interface org.bitbucket.cowwoc.requirements.MapRequirements
size() - Method in interface org.bitbucket.cowwoc.requirements.spi.CollectionRequirementsSpi
startsWith(String) - Method in interface org.bitbucket.cowwoc.requirements.StringRequirements: Ensures that the parameter starts with a value.
StringLengthRequirements - Interface in org.bitbucket.cowwoc.requirements: Verifies requirements of a String.length().
StringRequirements - Interface in org.bitbucket.cowwoc.requirements: Interface needed for Requirements.assertThat().

T

trim() - Method in interface org.bitbucket.cowwoc.requirements.StringRequirements: Trims whitespace at the beginning and end of the parameter.

U

UriRequirements - Interface in org.bitbucket.cowwoc.requirements: Interface needed for Requirements.assertThat().

V

values() - Method in interface org.bitbucket.cowwoc.requirements.MapRequirements

W

withContext(Map<String, Object>) - Method in class org.bitbucket.cowwoc.requirements.spi.Configuration: Supplies additional key-value pairs to output if a requirement is not met.
withContext(Map<String, Object>) - Method in interface org.bitbucket.cowwoc.requirements.spi.ObjectRequirementsSpi: Supplies additional key-value pairs to output if a requirement is not met.
withException(Class<? extends RuntimeException>) - Method in class org.bitbucket.cowwoc.requirements.spi.Configuration: Overrides the type of exception that will get thrown if a requirement fails.
withException(Class<? extends RuntimeException>) - Method in interface org.bitbucket.cowwoc.requirements.spi.ObjectRequirementsSpi: Overrides the type of exception that will get thrown if a requirement fails.

A B C D E F G I K L M N O P R S T U V W