Index (io7m-jaffirm-documentation 1.0.0 API)

A B C D E F H I O P S T V W

A

AffirmImmutableStyleType - Annotation Type in com.io7m.jaffirm.core: The immutables style count by the package.

B

build() - Method in class com.io7m.jaffirm.core.ContractCondition.Builder: Builds a new ContractCondition.
build() - Method in class com.io7m.jaffirm.core.ContractDoubleCondition.Builder: Builds a new ContractDoubleCondition.
build() - Method in class com.io7m.jaffirm.core.ContractIntCondition.Builder: Builds a new ContractIntCondition.
build() - Method in class com.io7m.jaffirm.core.ContractLongCondition.Builder: Builds a new ContractLongCondition.
builder() - Static method in class com.io7m.jaffirm.core.ContractCondition: Creates a builder for ContractCondition.
builder() - Static method in class com.io7m.jaffirm.core.ContractDoubleCondition: Creates a builder for ContractDoubleCondition.
builder() - Static method in class com.io7m.jaffirm.core.ContractIntCondition: Creates a builder for ContractIntCondition.
builder() - Static method in class com.io7m.jaffirm.core.ContractLongCondition: Creates a builder for ContractLongCondition.

C

checkInvariant(T, ContractConditionType<T>) - Static method in class com.io7m.jaffirm.core.Invariants: Evaluate the given predicate using value as input.
checkInvariant(T, Predicate<T>, Function<T, String>) - Static method in class com.io7m.jaffirm.core.Invariants: Evaluate the given predicate using value as input.
checkInvariant(T, boolean, Function<T, String>) - Static method in class com.io7m.jaffirm.core.Invariants: Evaluate the given predicate using value as input.
checkInvariant(boolean, String) - Static method in class com.io7m.jaffirm.core.Invariants: A specialized version of Invariants.checkInvariant(Object, boolean, Function) that does not mention an input value.
checkInvariant(boolean, Supplier<String>) - Static method in class com.io7m.jaffirm.core.Invariants: A specialized version of Invariants.checkInvariant(Object, boolean, Function) that does not mention an input value.
checkInvariantD(double, ContractDoubleConditionType) - Static method in class com.io7m.jaffirm.core.Invariants: A double specialized version of Invariants.checkInvariant(Object, ContractConditionType).
checkInvariantD(double, DoublePredicate, DoubleFunction<String>) - Static method in class com.io7m.jaffirm.core.Invariants: A double specialized version of Invariants.checkInvariant(Object, Predicate, Function)
checkInvariantD(double, boolean, DoubleFunction<String>) - Static method in class com.io7m.jaffirm.core.Invariants: A double specialized version of Invariants.checkInvariant(Object, boolean, Function)
checkInvariantI(int, ContractIntConditionType) - Static method in class com.io7m.jaffirm.core.Invariants: An int specialized version of Invariants.checkInvariant(Object, ContractConditionType).
checkInvariantI(int, IntPredicate, IntFunction<String>) - Static method in class com.io7m.jaffirm.core.Invariants: An int specialized version of Invariants.checkInvariant(Object, ContractConditionType).
checkInvariantI(int, boolean, IntFunction<String>) - Static method in class com.io7m.jaffirm.core.Invariants: An int specialized version of Invariants.checkInvariant(Object, boolean, Function).
checkInvariantL(long, ContractLongConditionType) - Static method in class com.io7m.jaffirm.core.Invariants: A long specialized version of Invariants.checkInvariant(Object, ContractConditionType).
checkInvariantL(long, LongPredicate, LongFunction<String>) - Static method in class com.io7m.jaffirm.core.Invariants: A long specialized version of Invariants.checkInvariant(Object, Predicate, Function)
checkInvariantL(long, boolean, LongFunction<String>) - Static method in class com.io7m.jaffirm.core.Invariants: A long specialized version of Invariants.checkInvariant(Object, Predicate, Function)
checkInvariants(T, ContractConditionType<T>...) - Static method in class com.io7m.jaffirm.core.Invariants: Evaluate all of the given conditions using value as input.
checkInvariantsD(double, ContractDoubleConditionType...) - Static method in class com.io7m.jaffirm.core.Invariants: A double specialized version of Invariants.checkInvariants(Object, ContractConditionType[])
checkInvariantsI(int, ContractIntConditionType...) - Static method in class com.io7m.jaffirm.core.Invariants: An int specialized version of Invariants.checkInvariants(Object, ContractConditionType[])
checkInvariantsL(long, ContractLongConditionType...) - Static method in class com.io7m.jaffirm.core.Invariants: A long specialized version of Invariants.checkInvariants(Object, ContractConditionType[])
checkPostcondition(T, ContractConditionType<T>) - Static method in class com.io7m.jaffirm.core.Postconditions: Evaluate the given predicate using value as input.
checkPostcondition(T, Predicate<T>, Function<T, String>) - Static method in class com.io7m.jaffirm.core.Postconditions: Evaluate the given predicate using value as input.
checkPostcondition(T, boolean, Function<T, String>) - Static method in class com.io7m.jaffirm.core.Postconditions: Evaluate the given predicate using value as input.
checkPostcondition(boolean, String) - Static method in class com.io7m.jaffirm.core.Postconditions: A specialized version of Postconditions.checkPostcondition(Object, boolean, Function) that does not mention an input value.
checkPostcondition(boolean, Supplier<String>) - Static method in class com.io7m.jaffirm.core.Postconditions: A specialized version of Postconditions.checkPostcondition(Object, boolean, Function) that does not mention an input value.
checkPostconditionD(double, ContractDoubleConditionType) - Static method in class com.io7m.jaffirm.core.Postconditions: A double specialized version of Postconditions.checkPostcondition(Object, ContractConditionType).
checkPostconditionD(double, DoublePredicate, DoubleFunction<String>) - Static method in class com.io7m.jaffirm.core.Postconditions: A double specialized version of Postconditions.checkPostcondition(Object, Predicate, Function)
checkPostconditionD(double, boolean, DoubleFunction<String>) - Static method in class com.io7m.jaffirm.core.Postconditions: A double specialized version of Postconditions.checkPostcondition(Object, boolean, Function)
checkPostconditionI(int, ContractIntConditionType) - Static method in class com.io7m.jaffirm.core.Postconditions: An int specialized version of Postconditions.checkPostcondition(Object, ContractConditionType).
checkPostconditionI(int, IntPredicate, IntFunction<String>) - Static method in class com.io7m.jaffirm.core.Postconditions: An int specialized version of Postconditions.checkPostcondition(Object, ContractConditionType).
checkPostconditionI(int, boolean, IntFunction<String>) - Static method in class com.io7m.jaffirm.core.Postconditions: An int specialized version of Postconditions.checkPostcondition(Object, boolean, Function).
checkPostconditionL(long, ContractLongConditionType) - Static method in class com.io7m.jaffirm.core.Postconditions: A long specialized version of Postconditions.checkPostcondition(Object, ContractConditionType).
checkPostconditionL(long, LongPredicate, LongFunction<String>) - Static method in class com.io7m.jaffirm.core.Postconditions: A long specialized version of Postconditions.checkPostcondition(Object, Predicate, Function)
checkPostconditionL(long, boolean, LongFunction<String>) - Static method in class com.io7m.jaffirm.core.Postconditions: A long specialized version of Postconditions.checkPostcondition(Object, Predicate, Function)
checkPostconditions(T, ContractConditionType<T>...) - Static method in class com.io7m.jaffirm.core.Postconditions: Evaluate all of the given conditions using value as input.
checkPostconditionsD(double, ContractDoubleConditionType...) - Static method in class com.io7m.jaffirm.core.Postconditions: A double specialized version of Postconditions.checkPostconditions(Object, ContractConditionType[])
checkPostconditionsI(int, ContractIntConditionType...) - Static method in class com.io7m.jaffirm.core.Postconditions: An int specialized version of Postconditions.checkPostconditions(Object, ContractConditionType[])
checkPostconditionsL(long, ContractLongConditionType...) - Static method in class com.io7m.jaffirm.core.Postconditions: A long specialized version of Postconditions.checkPostconditions(Object, ContractConditionType[])
checkPrecondition(T, ContractConditionType<T>) - Static method in class com.io7m.jaffirm.core.Preconditions: Evaluate the given predicate using value as input.
checkPrecondition(T, Predicate<T>, Function<T, String>) - Static method in class com.io7m.jaffirm.core.Preconditions: Evaluate the given predicate using value as input.
checkPrecondition(T, boolean, Function<T, String>) - Static method in class com.io7m.jaffirm.core.Preconditions: Evaluate the given predicate using value as input.
checkPrecondition(boolean, String) - Static method in class com.io7m.jaffirm.core.Preconditions: A specialized version of Preconditions.checkPrecondition(Object, boolean, Function) that does not mention an input value.
checkPrecondition(boolean, Supplier<String>) - Static method in class com.io7m.jaffirm.core.Preconditions: A specialized version of Preconditions.checkPrecondition(Object, boolean, Function) that does not mention an input value.
checkPreconditionD(double, ContractDoubleConditionType) - Static method in class com.io7m.jaffirm.core.Preconditions: A double specialized version of Preconditions.checkPrecondition(Object, ContractConditionType).
checkPreconditionD(double, DoublePredicate, DoubleFunction<String>) - Static method in class com.io7m.jaffirm.core.Preconditions: A double specialized version of Preconditions.checkPrecondition(Object, Predicate, Function)
checkPreconditionD(double, boolean, DoubleFunction<String>) - Static method in class com.io7m.jaffirm.core.Preconditions: A double specialized version of Preconditions.checkPrecondition(Object, boolean, Function)
checkPreconditionI(int, ContractIntConditionType) - Static method in class com.io7m.jaffirm.core.Preconditions: An int specialized version of Preconditions.checkPrecondition(Object, ContractConditionType).
checkPreconditionI(int, IntPredicate, IntFunction<String>) - Static method in class com.io7m.jaffirm.core.Preconditions: An int specialized version of Preconditions.checkPrecondition(Object, ContractConditionType).
checkPreconditionI(int, boolean, IntFunction<String>) - Static method in class com.io7m.jaffirm.core.Preconditions: An int specialized version of Preconditions.checkPrecondition(Object, boolean, Function).
checkPreconditionL(long, ContractLongConditionType) - Static method in class com.io7m.jaffirm.core.Preconditions: A long specialized version of Preconditions.checkPrecondition(Object, ContractConditionType).
checkPreconditionL(long, LongPredicate, LongFunction<String>) - Static method in class com.io7m.jaffirm.core.Preconditions: A long specialized version of Preconditions.checkPrecondition(Object, Predicate, Function)
checkPreconditionL(long, boolean, LongFunction<String>) - Static method in class com.io7m.jaffirm.core.Preconditions: A long specialized version of Preconditions.checkPrecondition(Object, Predicate, Function)
checkPreconditions(T, ContractConditionType<T>...) - Static method in class com.io7m.jaffirm.core.Preconditions: Evaluate all of the given conditions using value as input.
checkPreconditionsD(double, ContractDoubleConditionType...) - Static method in class com.io7m.jaffirm.core.Preconditions: A double specialized version of Preconditions.checkPreconditions(Object, ContractConditionType[])
checkPreconditionsI(int, ContractIntConditionType...) - Static method in class com.io7m.jaffirm.core.Preconditions: An int specialized version of Preconditions.checkPreconditions(Object, ContractConditionType[])
checkPreconditionsL(long, ContractLongConditionType...) - Static method in class com.io7m.jaffirm.core.Preconditions: A long specialized version of Preconditions.checkPreconditions(Object, ContractConditionType[])
com.io7m.jaffirm.core - package com.io7m.jaffirm.core: Core types and functions.
com.io7m.jaffirm.documentation - package com.io7m.jaffirm.documentation: Documentation.
condition(Predicate<T>, Function<T, String>) - Static method in class com.io7m.jaffirm.core.Contracts: Construct a predicate from the given predicate function and describer.
conditionD(DoublePredicate, DoubleFunction<String>) - Static method in class com.io7m.jaffirm.core.Contracts: Construct a double specialized predicate from the given predicate function and describer.
conditionI(IntPredicate, IntFunction<String>) - Static method in class com.io7m.jaffirm.core.Contracts: Construct an int specialized predicate from the given predicate function and describer.
conditionL(LongPredicate, LongFunction<String>) - Static method in class com.io7m.jaffirm.core.Contracts: Construct a long specialized predicate from the given predicate function and describer.
ContractCondition<T> - Class in com.io7m.jaffirm.core: An individual predicate in a contract.
ContractCondition.Builder<T> - Class in com.io7m.jaffirm.core: Builds instances of type ContractCondition.
ContractConditionType<T> - Interface in com.io7m.jaffirm.core: An individual predicate in a contract.
ContractDoubleCondition - Class in com.io7m.jaffirm.core: A double specialized version of the ContractConditionType type.
ContractDoubleCondition.Builder - Class in com.io7m.jaffirm.core: Builds instances of type ContractDoubleCondition.
ContractDoubleConditionType - Interface in com.io7m.jaffirm.core: A double specialized version of the ContractConditionType type.
ContractException - Exception in com.io7m.jaffirm.core: One or more conditions have been violated.
ContractException(String, int) - Constructor for exception com.io7m.jaffirm.core.ContractException: Construct an exception.
ContractIntCondition - Class in com.io7m.jaffirm.core: An int specialized version of the ContractConditionType type.
ContractIntCondition.Builder - Class in com.io7m.jaffirm.core: Builds instances of type ContractIntCondition.
ContractIntConditionType - Interface in com.io7m.jaffirm.core: An int specialized version of the ContractConditionType type.
ContractLongCondition - Class in com.io7m.jaffirm.core: A long specialized version of the ContractConditionType type.
ContractLongCondition.Builder - Class in com.io7m.jaffirm.core: Builds instances of type ContractLongCondition.
ContractLongConditionType - Interface in com.io7m.jaffirm.core: A long specialized version of the ContractConditionType type.
Contracts - Class in com.io7m.jaffirm.core: Functions to create contracts and conditions.
copyOf(ContractConditionType<T>) - Static method in class com.io7m.jaffirm.core.ContractCondition: Creates an immutable copy of a ContractConditionType value.
copyOf(ContractDoubleConditionType) - Static method in class com.io7m.jaffirm.core.ContractDoubleCondition: Creates an immutable copy of a ContractDoubleConditionType value.
copyOf(ContractIntConditionType) - Static method in class com.io7m.jaffirm.core.ContractIntCondition: Creates an immutable copy of a ContractIntConditionType value.
copyOf(ContractLongConditionType) - Static method in class com.io7m.jaffirm.core.ContractLongCondition: Creates an immutable copy of a ContractLongConditionType value.

D

describer() - Method in class com.io7m.jaffirm.core.ContractCondition
describer() - Method in interface com.io7m.jaffirm.core.ContractConditionType
describer() - Method in class com.io7m.jaffirm.core.ContractDoubleCondition
describer() - Method in interface com.io7m.jaffirm.core.ContractDoubleConditionType
describer() - Method in class com.io7m.jaffirm.core.ContractIntCondition
describer() - Method in interface com.io7m.jaffirm.core.ContractIntConditionType
describer() - Method in class com.io7m.jaffirm.core.ContractLongCondition
describer() - Method in interface com.io7m.jaffirm.core.ContractLongConditionType
Documentation - Class in com.io7m.jaffirm.documentation: Marker class for looking up files by resource.

E

equals(Object) - Method in class com.io7m.jaffirm.core.ContractCondition: This instance is equal to all instances of ContractCondition that have equal attribute values.
equals(Object) - Method in class com.io7m.jaffirm.core.ContractDoubleCondition: This instance is equal to all instances of ContractDoubleCondition that have equal attribute values.
equals(Object) - Method in class com.io7m.jaffirm.core.ContractIntCondition: This instance is equal to all instances of ContractIntCondition that have equal attribute values.
equals(Object) - Method in class com.io7m.jaffirm.core.ContractLongCondition: This instance is equal to all instances of ContractLongCondition that have equal attribute values.

F

from(ContractConditionType<T>) - Method in class com.io7m.jaffirm.core.ContractCondition.Builder: Fill a builder with attribute values from the provided ContractConditionType instance.
from(ContractDoubleConditionType) - Method in class com.io7m.jaffirm.core.ContractDoubleCondition.Builder: Fill a builder with attribute values from the provided ContractDoubleConditionType instance.
from(ContractIntConditionType) - Method in class com.io7m.jaffirm.core.ContractIntCondition.Builder: Fill a builder with attribute values from the provided ContractIntConditionType instance.
from(ContractLongConditionType) - Method in class com.io7m.jaffirm.core.ContractLongCondition.Builder: Fill a builder with attribute values from the provided ContractLongConditionType instance.

H

hashCode() - Method in class com.io7m.jaffirm.core.ContractCondition: Computes a hash code from attributes: predicate, describer.
hashCode() - Method in class com.io7m.jaffirm.core.ContractDoubleCondition: Computes a hash code from attributes: predicate, describer.
hashCode() - Method in class com.io7m.jaffirm.core.ContractIntCondition: Computes a hash code from attributes: predicate, describer.
hashCode() - Method in class com.io7m.jaffirm.core.ContractLongCondition: Computes a hash code from attributes: predicate, describer.

I

Invariants - Class in com.io7m.jaffirm.core: Functions to check invariants.
InvariantViolationException - Exception in com.io7m.jaffirm.core: One or more invariants have been violated.
InvariantViolationException(String, int) - Constructor for exception com.io7m.jaffirm.core.InvariantViolationException: Construct an exception.

O

of(Predicate<T>, Function<T, String>) - Static method in class com.io7m.jaffirm.core.ContractCondition: Construct a new immutable ContractCondition instance.
of(DoublePredicate, DoubleFunction<String>) - Static method in class com.io7m.jaffirm.core.ContractDoubleCondition: Construct a new immutable ContractDoubleCondition instance.
of(IntPredicate, IntFunction<String>) - Static method in class com.io7m.jaffirm.core.ContractIntCondition: Construct a new immutable ContractIntCondition instance.
of(LongPredicate, LongFunction<String>) - Static method in class com.io7m.jaffirm.core.ContractLongCondition: Construct a new immutable ContractLongCondition instance.

P

Postconditions - Class in com.io7m.jaffirm.core: Functions to check postconditions.
PostconditionViolationException - Exception in com.io7m.jaffirm.core: One or more postconditions have been violated.
PostconditionViolationException(String, int) - Constructor for exception com.io7m.jaffirm.core.PostconditionViolationException: Construct an exception.
Preconditions - Class in com.io7m.jaffirm.core: Functions to check preconditions.
PreconditionViolationException - Exception in com.io7m.jaffirm.core: One or more checkPreconditions have been violated.
PreconditionViolationException(String, int) - Constructor for exception com.io7m.jaffirm.core.PreconditionViolationException: Construct an exception.
predicate() - Method in class com.io7m.jaffirm.core.ContractCondition
predicate() - Method in interface com.io7m.jaffirm.core.ContractConditionType
predicate() - Method in class com.io7m.jaffirm.core.ContractDoubleCondition
predicate() - Method in interface com.io7m.jaffirm.core.ContractDoubleConditionType
predicate() - Method in class com.io7m.jaffirm.core.ContractIntCondition
predicate() - Method in interface com.io7m.jaffirm.core.ContractIntConditionType
predicate() - Method in class com.io7m.jaffirm.core.ContractLongCondition
predicate() - Method in interface com.io7m.jaffirm.core.ContractLongConditionType

S

setDescriber(Function<T, String>) - Method in class com.io7m.jaffirm.core.ContractCondition.Builder: Initializes the value for the describer attribute.
setDescriber(DoubleFunction<String>) - Method in class com.io7m.jaffirm.core.ContractDoubleCondition.Builder: Initializes the value for the describer attribute.
setDescriber(IntFunction<String>) - Method in class com.io7m.jaffirm.core.ContractIntCondition.Builder: Initializes the value for the describer attribute.
setDescriber(LongFunction<String>) - Method in class com.io7m.jaffirm.core.ContractLongCondition.Builder: Initializes the value for the describer attribute.
setPredicate(Predicate<T>) - Method in class com.io7m.jaffirm.core.ContractCondition.Builder: Initializes the value for the predicate attribute.
setPredicate(DoublePredicate) - Method in class com.io7m.jaffirm.core.ContractDoubleCondition.Builder: Initializes the value for the predicate attribute.
setPredicate(IntPredicate) - Method in class com.io7m.jaffirm.core.ContractIntCondition.Builder: Initializes the value for the predicate attribute.
setPredicate(LongPredicate) - Method in class com.io7m.jaffirm.core.ContractLongCondition.Builder: Initializes the value for the predicate attribute.

T

toString() - Method in class com.io7m.jaffirm.core.ContractCondition: Prints the immutable value ContractCondition with attribute values.
toString() - Method in class com.io7m.jaffirm.core.ContractDoubleCondition: Prints the immutable value ContractDoubleCondition with attribute values.
toString() - Method in class com.io7m.jaffirm.core.ContractIntCondition: Prints the immutable value ContractIntCondition with attribute values.
toString() - Method in class com.io7m.jaffirm.core.ContractLongCondition: Prints the immutable value ContractLongCondition with attribute values.

V

violations() - Method in exception com.io7m.jaffirm.core.ContractException

W

withDescriber(Function<T, String>) - Method in class com.io7m.jaffirm.core.ContractCondition: Copy the current immutable object by setting a value for the describer attribute.
withDescriber(DoubleFunction<String>) - Method in class com.io7m.jaffirm.core.ContractDoubleCondition: Copy the current immutable object by setting a value for the describer attribute.
withDescriber(IntFunction<String>) - Method in class com.io7m.jaffirm.core.ContractIntCondition: Copy the current immutable object by setting a value for the describer attribute.
withDescriber(LongFunction<String>) - Method in class com.io7m.jaffirm.core.ContractLongCondition: Copy the current immutable object by setting a value for the describer attribute.
withPredicate(Predicate<T>) - Method in class com.io7m.jaffirm.core.ContractCondition: Copy the current immutable object by setting a value for the predicate attribute.
withPredicate(DoublePredicate) - Method in class com.io7m.jaffirm.core.ContractDoubleCondition: Copy the current immutable object by setting a value for the predicate attribute.
withPredicate(IntPredicate) - Method in class com.io7m.jaffirm.core.ContractIntCondition: Copy the current immutable object by setting a value for the predicate attribute.
withPredicate(LongPredicate) - Method in class com.io7m.jaffirm.core.ContractLongCondition: Copy the current immutable object by setting a value for the predicate attribute.

A B C D E F H I O P S T V W