A B C D E F G H I J L M N O P R S T U V W
A
- accept(T) - Method in interface net.groboclown.retval.function.NonnullConsumer
-
Accept the value into the consumer.
- accept(T, V) - Method in interface net.groboclown.retval.function.NonnullBiConsumer
-
Accept the two values into the consumer.
- accept(T, V) - Method in interface net.groboclown.retval.function.NonnullFirstBiConsumer
-
The caller must assert the non-null validity of the arguments; the receiver should safely assume the argument is non-null.
- accumulateValues() - Static method in class net.groboclown.retval.Ret
-
Convenience function to create a
ValueAccumulator. - add(Problem) - Method in class net.groboclown.retval.ProblemCollector
-
Adds a single problem to the collection.
- add(RetNullable<T>) - Method in class net.groboclown.retval.ValueAccumulator
-
Add a value into this accumulator if the return value is ok, otherwise add the problems.
- add(RetVal<T>) - Method in class net.groboclown.retval.ValueAccumulator
-
Add a value into this accumulator if the return value is ok, otherwise add the problems.
- add(ValuedProblemContainer<T>) - Method in class net.groboclown.retval.ValueAccumulator
-
Add a value into this accumulator if the return value is ok, otherwise add the problems.
- addAll(Iterable<Problem>) - Method in class net.groboclown.retval.ProblemCollector
-
Adds a single problem to the collection.
- addAll(Iterable<ValuedProblemContainer<T>>) - Method in class net.groboclown.retval.ValueAccumulator
-
Add a list of values into this accumulator.
- addAllValues(Iterable<T>) - Method in class net.groboclown.retval.ValueAccumulator
-
Add vararg list of values into this accumulator.
- addValue(T) - Method in class net.groboclown.retval.ValueAccumulator
-
Add vararg list of values into this accumulator.
- anyProblems() - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- anyProblems() - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- anyProblems() - Method in class net.groboclown.retval.impl.MonitoredRetVoidOk
- anyProblems() - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- anyProblems() - Method in class net.groboclown.retval.impl.SimpleReturnValue
- anyProblems() - Method in class net.groboclown.retval.impl.SimpleRetVoidOk
- anyProblems() - Method in class net.groboclown.retval.ProblemCollector
- anyProblems() - Method in interface net.groboclown.retval.ProblemContainer
-
Return all the problems in this object, even if the container is "ok".
- anyProblems() - Method in class net.groboclown.retval.ValueAccumulator
- anyProblems() - Method in class net.groboclown.retval.ValueBuilder
- anyProblems() - Method in class net.groboclown.retval.WarningVal
- apply(T) - Method in interface net.groboclown.retval.function.NonnullFunction
-
Run the function.
- apply(T) - Method in interface net.groboclown.retval.function.NonnullParamFunction
-
Runs the function.
- apply(T) - Method in interface net.groboclown.retval.function.NonnullReturnFunction
-
Run the function.
- apply(T) - Method in interface net.groboclown.retval.function.NonnullThrowsFunction
-
Run the function.
- asNullable() - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- asNullable() - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- asNullable() - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- asNullable() - Method in class net.groboclown.retval.impl.SimpleReturnValue
- asNullable() - Method in interface net.groboclown.retval.RetVal
-
Convert this instance into a nullable instance with the same value type.
- asOptional() - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- asOptional() - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- asOptional() - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- asOptional() - Method in class net.groboclown.retval.impl.SimpleReturnValue
- asOptional() - Method in interface net.groboclown.retval.RetNullable
-
Convert the value into an optional typed value.
- asOptional() - Method in interface net.groboclown.retval.RetVal
-
Convert the value into an optional typed value.
- asRetVal() - Method in class net.groboclown.retval.ValueAccumulator
-
Returns the accumulated values as a RetVal if there are no problems, otherwise the enclosed problems.
- asRetValList() - Method in class net.groboclown.retval.ValueAccumulator
-
Return the value as an unmodifiable List, rather than as a generic Collection.
- asWarning() - Method in class net.groboclown.retval.ValueAccumulator
-
Return this accumulator as a warning value, containing both all collected values (up to this point) and discovered problems.
- asWarning() - Method in class net.groboclown.retval.ValueBuilder
-
Create a warning version of this builder.
- asWarning(T) - Method in class net.groboclown.retval.ProblemCollector
-
Convert this collection to a warning, containing all this collector's problems along with the argument value.
B
- buildValue(T) - Static method in class net.groboclown.retval.Ret
-
Convenience function to create a
WarningValinstance for the given value.
C
- closeWith(T, NonnullThrowsFunction<T, RetVal<R>>) - Static method in class net.groboclown.retval.Ret
-
Runs a function with a closable value.
- closeWithNullable(T, NonnullThrowsFunction<T, RetNullable<R>>) - Static method in class net.groboclown.retval.Ret
-
Runs a function with a closable value.
- closeWithVoid(T, NonnullThrowsFunction<T, RetVoid>) - Static method in class net.groboclown.retval.Ret
-
Runs a function with a closable value.
- CollectionUtil - Class in net.groboclown.retval.impl
-
Internal helper class for working with collections.
- collectProblems() - Static method in class net.groboclown.retval.Ret
-
Convenience function to create a
ProblemCollector. - complete(T) - Method in class net.groboclown.retval.ProblemCollector
-
Return a non-null value, or, if the collector has problems, the problems.
- completeNullable(T) - Method in class net.groboclown.retval.ProblemCollector
-
Return a nullable value, unless this collector has problems, in which case a
RetNullableis returned with the problems. - completeVoid() - Method in class net.groboclown.retval.ProblemCollector
-
Return the collection of problems as a
RetVoid. - consume(Consumer<T>) - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- consume(Consumer<T>) - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- consume(Consumer<T>) - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- consume(Consumer<T>) - Method in class net.groboclown.retval.impl.SimpleReturnValue
- consume(Consumer<T>) - Method in interface net.groboclown.retval.RetNullable
-
Pass the value of this instance to the consumer, only if there are no problems.
- consume(NonnullConsumer<T>) - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- consume(NonnullConsumer<T>) - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- consume(NonnullConsumer<T>) - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- consume(NonnullConsumer<T>) - Method in class net.groboclown.retval.impl.SimpleReturnValue
- consume(NonnullConsumer<T>) - Method in interface net.groboclown.retval.RetVal
-
Pass the value of this instance to the consumer, only if there are no problems.
- consumeIfNonnull(NonnullConsumer<T>) - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- consumeIfNonnull(NonnullConsumer<T>) - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- consumeIfNonnull(NonnullConsumer<T>) - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- consumeIfNonnull(NonnullConsumer<T>) - Method in class net.groboclown.retval.impl.SimpleReturnValue
- consumeIfNonnull(NonnullConsumer<T>) - Method in interface net.groboclown.retval.RetNullable
-
If this value has a problem, then it is returned as a
RetVoid. - copyNonNullValues(Collection<Problem>) - Static method in class net.groboclown.retval.impl.CollectionUtil
-
Performs a copy that enforces the values to be non-null.
- createNullableFromProblems(List<Problem>) - Method in class net.groboclown.retval.impl.MonitoredFactory
- createNullableFromProblems(List<Problem>) - Method in interface net.groboclown.retval.impl.ReturnTypeFactory
-
Create a
RetNullableinstance with one or more problems. - createNullableFromProblems(List<Problem>) - Method in class net.groboclown.retval.impl.SimpleFactory
- createNullableOk(T) - Method in class net.groboclown.retval.impl.MonitoredFactory
- createNullableOk(T) - Method in interface net.groboclown.retval.impl.ReturnTypeFactory
-
Create a
RetNullableinstance with a value. - createNullableOk(T) - Method in class net.groboclown.retval.impl.SimpleFactory
- createValFromProblems(List<Problem>) - Method in class net.groboclown.retval.impl.MonitoredFactory
- createValFromProblems(List<Problem>) - Method in interface net.groboclown.retval.impl.ReturnTypeFactory
-
Create a new RetVal instance that has errors.
- createValFromProblems(List<Problem>) - Method in class net.groboclown.retval.impl.SimpleFactory
- createValOk(T) - Method in class net.groboclown.retval.impl.MonitoredFactory
- createValOk(T) - Method in interface net.groboclown.retval.impl.ReturnTypeFactory
-
Create a new RetVal instance that has a value and no problems.
- createValOk(T) - Method in class net.groboclown.retval.impl.SimpleFactory
- createVoidFromProblems(List<Problem>) - Method in class net.groboclown.retval.impl.MonitoredFactory
- createVoidFromProblems(List<Problem>) - Method in interface net.groboclown.retval.impl.ReturnTypeFactory
-
Constructs a
RetVoidinstance with the collections of problems. - createVoidFromProblems(List<Problem>) - Method in class net.groboclown.retval.impl.SimpleFactory
- createVoidOk() - Method in class net.groboclown.retval.impl.MonitoredFactory
- createVoidOk() - Method in interface net.groboclown.retval.impl.ReturnTypeFactory
-
Return a void object with no problems.
- createVoidOk() - Method in class net.groboclown.retval.impl.SimpleFactory
D
- DebugObservedMonitor<T> - Class in net.groboclown.retval.monitor
-
Maintains information about objects that need to be checked in a phantom reference cleaner.
- DebugObservedMonitor(String, NotCompletedListener) - Constructor for class net.groboclown.retval.monitor.DebugObservedMonitor
-
Create a new monitor instance.
- debugProblems(String) - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- debugProblems(String) - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- debugProblems(String) - Method in class net.groboclown.retval.impl.MonitoredRetVoidOk
- debugProblems(String) - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- debugProblems(String) - Method in class net.groboclown.retval.impl.SimpleReturnValue
- debugProblems(String) - Method in class net.groboclown.retval.impl.SimpleRetVoidOk
- debugProblems(String) - Method in class net.groboclown.retval.ProblemCollector
- debugProblems(String) - Method in interface net.groboclown.retval.ProblemContainer
-
Return the problems as a single string, which combines the
Object.toString()output of each problem with the given joining string parameter. - debugProblems(String) - Method in class net.groboclown.retval.ValueAccumulator
- debugProblems(String) - Method in class net.groboclown.retval.ValueBuilder
- debugProblems(String) - Method in class net.groboclown.retval.WarningVal
- defaultAs(T) - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- defaultAs(T) - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- defaultAs(T) - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- defaultAs(T) - Method in class net.groboclown.retval.impl.SimpleReturnValue
- defaultAs(T) - Method in interface net.groboclown.retval.RetNullable
-
Returns this object as a
RetValif it is not null, otherwise a value with the returned value. - defaultOrMap(R, NonnullFunction<T, R>) - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- defaultOrMap(R, NonnullFunction<T, R>) - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- defaultOrMap(R, NonnullFunction<T, R>) - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- defaultOrMap(R, NonnullFunction<T, R>) - Method in class net.groboclown.retval.impl.SimpleReturnValue
- defaultOrMap(R, NonnullFunction<T, R>) - Method in interface net.groboclown.retval.RetNullable
-
If this value has a problem, then it is returned.
- defaultOrThen(R, NonnullFunction<T, RetVal<R>>) - Method in interface net.groboclown.retval.RetNullable
-
If this value has a problem, then it is returned.
- discoverCheckedInstance() - Static method in class net.groboclown.retval.env.ObservedMonitorDetection
-
Checks system settings for the correct instance to load.
- discoverReturnTypeFactory() - Static method in class net.groboclown.retval.env.ReturnTypeFactoryDetection
-
Checks system settings for the correct factory to load.
E
- enforceHasProblems(Collection<Problem>) - Static method in class net.groboclown.retval.Ret
-
Enforce that the list of problems is not empty by throwing an IllegalStateException if it does not contain problems.
- enforceNoProblems(Collection<Problem>) - Static method in class net.groboclown.retval.Ret
-
Enforce that the list of problems is empty by throwing an IllegalStateException if it contains problems.
- equals(Object) - Method in class net.groboclown.retval.problems.LocalizedProblem
- evaluate() - Method in class net.groboclown.retval.ValueBuilder
-
Convert this builder into a
RetVal; if any problems exist, then the returned object will have those problems, otherwise it will contain the value.
F
- FileProblem - Class in net.groboclown.retval.problems
-
A problem that comes from a known file.
- findRegistered(T) - Method in class net.groboclown.retval.monitor.MockObservedMonitor
-
Finds the registered instance for the observed object.
- forwardNullableProblems() - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- forwardNullableProblems() - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- forwardNullableProblems() - Method in class net.groboclown.retval.impl.MonitoredRetVoidOk
- forwardNullableProblems() - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- forwardNullableProblems() - Method in class net.groboclown.retval.impl.SimpleReturnValue
- forwardNullableProblems() - Method in class net.groboclown.retval.impl.SimpleRetVoidOk
- forwardNullableProblems() - Method in interface net.groboclown.retval.RetNullable
-
Forward this instance as a nullable with a different value type, but only if it has problems.
- forwardNullableProblems() - Method in interface net.groboclown.retval.RetVal
-
Forward this instance as a nullable with a different value type, but only if it has problems.
- forwardNullableProblems() - Method in interface net.groboclown.retval.RetVoid
-
Forward this instance as a nullable with a value type, but only if it has problems.
- forwardProblems() - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- forwardProblems() - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- forwardProblems() - Method in class net.groboclown.retval.impl.MonitoredRetVoidOk
- forwardProblems() - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- forwardProblems() - Method in class net.groboclown.retval.impl.SimpleReturnValue
- forwardProblems() - Method in class net.groboclown.retval.impl.SimpleRetVoidOk
- forwardProblems() - Method in interface net.groboclown.retval.RetNullable
-
Forward this object to RetVal instance, possibly as a different value type.
- forwardProblems() - Method in interface net.groboclown.retval.RetVal
-
Forward this object to a different typed RetVal instance.
- forwardProblems() - Method in interface net.groboclown.retval.RetVoid
-
Forward this object to a typed RetVal instance.
- forwardVoidProblems() - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- forwardVoidProblems() - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- forwardVoidProblems() - Method in class net.groboclown.retval.impl.MonitoredRetVoidOk
- forwardVoidProblems() - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- forwardVoidProblems() - Method in class net.groboclown.retval.impl.SimpleReturnValue
- forwardVoidProblems() - Method in class net.groboclown.retval.impl.SimpleRetVoidOk
- forwardVoidProblems() - Method in interface net.groboclown.retval.RetNullable
-
Forward this instance as a value-less object, but only if it has problems.
- forwardVoidProblems() - Method in interface net.groboclown.retval.RetVal
-
Forward this instance as a value-less object, but only if it has problems.
- forwardVoidProblems() - Method in interface net.groboclown.retval.RetVoid
-
Forward this instance as a value-less object, but only if it has problems.
- from() - Static method in class net.groboclown.retval.ProblemCollector
-
Create an empty problem collector.
- from() - Static method in class net.groboclown.retval.ValueAccumulator
-
Create a new, empty value accumulator instance.
- from(File, IOException) - Static method in class net.groboclown.retval.problems.FileProblem
-
Create a file problem from a file object and an I/O exception.
- from(String) - Static method in class net.groboclown.retval.problems.LocalizedProblem
-
Create a problem from a localized string.
- from(String, IOException) - Static method in class net.groboclown.retval.problems.FileProblem
-
Create a file problem from a file object and an I/O exception.
- from(String, String) - Static method in class net.groboclown.retval.problems.FileProblem
-
Create the file problem from the file path and message.
- from(List<Problem>, List<Problem>...) - Static method in class net.groboclown.retval.ProblemCollector
-
Populate this collector from lists of problems.
- from(Problem, Problem...) - Static method in class net.groboclown.retval.ProblemCollector
-
Populate this collector from problems.
- from(Problem, Problem...) - Static method in class net.groboclown.retval.ValueAccumulator
-
Create a new value accumulator that starts with the given problem(s).
- from(RetNullable<T>) - Static method in class net.groboclown.retval.ValueAccumulator
-
Create a new value accumulator that starts with the given value or problems.
- from(RetNullable<T>, Consumer<T>) - Static method in class net.groboclown.retval.ProblemCollector
-
Create a new RetCollector and invoke
ProblemCollector.with(RetNullable, Consumer). - from(RetVal<T>) - Static method in class net.groboclown.retval.ValueAccumulator
-
Create a new value accumulator that starts with the given value or problems.
- from(RetVal<T>, NonnullConsumer<T>) - Static method in class net.groboclown.retval.ProblemCollector
-
Create a new RetCollector and invoke
ProblemCollector.with(RetVal, NonnullConsumer). - from(RetVoid, RetVoid...) - Static method in class net.groboclown.retval.ProblemCollector
-
Create a new RetCollector and invoke
ProblemCollector.with(RetVal, NonnullConsumer). - from(T) - Static method in class net.groboclown.retval.ValueBuilder
-
Construct a new value builder for the given initial state of the value.
- from(T) - Static method in class net.groboclown.retval.WarningVal
-
Create the warning from a value with no problems.
- from(T, ProblemContainer) - Static method in class net.groboclown.retval.WarningVal
-
Create a warning value with a collection (possibly empty) of problems.
- fromProblem(Collection<Problem>, Collection<Problem>...) - Static method in interface net.groboclown.retval.RetNullable
-
Create a nullable return object from collections of problems.
- fromProblem(Collection<Problem>, Collection<Problem>...) - Static method in interface net.groboclown.retval.RetVal
-
Create a new RetVal instance that has problems stored in collections of problems.
- fromProblem(Collection<Problem>, Collection<Problem>...) - Static method in interface net.groboclown.retval.RetVoid
-
Constructs a
RetVoidinstance with the collections of problems. - fromProblem(Problem, Problem...) - Static method in interface net.groboclown.retval.RetNullable
-
Create a nullable return object with at least one problem.
- fromProblem(Problem, Problem...) - Static method in interface net.groboclown.retval.RetVal
-
Create a new RetVal instance that has problems.
- fromProblem(Problem, Problem...) - Static method in interface net.groboclown.retval.RetVoid
-
Create a RetVoid containing the passed-in problems.
- fromProblems(Collection<ProblemContainer>, Collection<ProblemContainer>...) - Static method in interface net.groboclown.retval.RetNullable
- fromProblems(Collection<ProblemContainer>, Collection<ProblemContainer>...) - Static method in interface net.groboclown.retval.RetVal
-
Create a new RetVal instance that has problems.
- fromProblems(Collection<ProblemContainer>, Collection<ProblemContainer>...) - Static method in interface net.groboclown.retval.RetVoid
-
Create a RetVoid containing the passed-in problems.
- fromProblems(ProblemContainer, ProblemContainer...) - Static method in interface net.groboclown.retval.RetNullable
- fromProblems(ProblemContainer, ProblemContainer...) - Static method in interface net.groboclown.retval.RetVal
-
Create a new RetVal instance that has problems.
- fromProblems(ProblemContainer, ProblemContainer...) - Static method in interface net.groboclown.retval.RetVoid
-
Create a RetVoid containing the passed-in problems.
G
- get() - Method in interface net.groboclown.retval.function.NonnullSupplier
-
Generates the return value.
- getCallCount() - Method in class net.groboclown.retval.monitor.MockObservedMonitor.Registered
-
Get the number of times the
MockObservedMonitor.Registered.onObserved()method was called. - getCheckedInstance() - Static method in class net.groboclown.retval.monitor.ObservedMonitorRegistrar
- getCollector() - Method in class net.groboclown.retval.ValueAccumulator
-
Get the underlying collector object, for adding arbitrary problems to the accumulator.
- getCollector() - Method in class net.groboclown.retval.ValueBuilder
-
Get the underlying problem collector.
- getFactory() - Static method in class net.groboclown.retval.impl.RetGenerator
-
Allows for querying the active return type factory.
- getInstance() - Static method in class net.groboclown.retval.monitor.NoOpObservedMonitor
-
Type-cast the placeholder No Op implementation to the needed format.
- getNeverObserved() - Method in class net.groboclown.retval.monitor.MockObservedMonitor
-
Return all registered closeable objects that never had the close called on the listener.
- getObservable() - Method in class net.groboclown.retval.monitor.MockObservedMonitor.Registered
-
Get the closeable instance.
- getPrevious() - Method in class net.groboclown.retval.monitor.MockObservedMonitor
-
Get the previously installed monitor, which this monitor replaced.
- getPreviousReturnTypeFactory() - Method in class net.groboclown.retval.monitor.MockObservedMonitor
-
Get the previously installed return type factory, which this object replaced.
- getSource() - Method in class net.groboclown.retval.problems.FileProblem
- getSource() - Method in interface net.groboclown.retval.SourcedProblem
-
A single source of the problem.
- getSourceException() - Method in class net.groboclown.retval.problems.UnhandledExceptionProblem
-
Get the exception that caused this problem.
- getValue() - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- getValue() - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- getValue() - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- getValue() - Method in class net.groboclown.retval.impl.SimpleReturnValue
- getValue() - Method in interface net.groboclown.retval.RetNullable
-
Get the value stored in this object, even if it has problems.
- getValue() - Method in interface net.groboclown.retval.RetVal
-
Get the value contained in this instance.
- getValue() - Method in class net.groboclown.retval.ValueBuilder
-
Get the value stored in this builder.
- getValue() - Method in interface net.groboclown.retval.ValuedProblemContainer
-
Get the underlying value object, regardless of the problem state of the container.
- getValue() - Method in class net.groboclown.retval.WarningVal
-
Get the underlying value object.
- getValues() - Method in class net.groboclown.retval.ValueAccumulator
-
Get all valid values collected so far, even if there are also problems.
H
- hashCode() - Method in class net.groboclown.retval.problems.LocalizedProblem
- hasProblems() - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- hasProblems() - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- hasProblems() - Method in class net.groboclown.retval.impl.MonitoredRetVoidOk
- hasProblems() - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- hasProblems() - Method in class net.groboclown.retval.impl.SimpleReturnValue
- hasProblems() - Method in class net.groboclown.retval.impl.SimpleRetVoidOk
- hasProblems() - Method in class net.groboclown.retval.ProblemCollector
- hasProblems() - Method in interface net.groboclown.retval.ProblemContainer
-
Returns whether this object contains 1 or more problems.
- hasProblems() - Method in class net.groboclown.retval.ValueAccumulator
- hasProblems() - Method in class net.groboclown.retval.ValueBuilder
- hasProblems() - Method in class net.groboclown.retval.WarningVal
I
- INSTANCE - Static variable in class net.groboclown.retval.impl.MonitoredFactory
- INSTANCE - Static variable in class net.groboclown.retval.impl.SimpleFactory
- INSTANCE - Static variable in class net.groboclown.retval.monitor.LoggingNotCompletedListener
- instanceNotCompleted(String, String, StackTraceElement[]) - Method in class net.groboclown.retval.monitor.LoggingNotCompletedListener
- instanceNotCompleted(String, String, StackTraceElement[]) - Method in interface net.groboclown.retval.monitor.NotCompletedListener
-
Called when a monitor detects that a registered instance went out of scope from the JVM but was never marked as completed.
- isCheckedTraceEnabled() - Static method in class net.groboclown.retval.monitor.ObservedMonitorRegistrar
-
Is tracing enabled? If not enabled, then more memory efficient versions of objects may be used.
- isOk() - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- isOk() - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- isOk() - Method in class net.groboclown.retval.impl.MonitoredRetVoidOk
- isOk() - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- isOk() - Method in class net.groboclown.retval.impl.SimpleReturnValue
- isOk() - Method in class net.groboclown.retval.impl.SimpleRetVoidOk
- isOk() - Method in class net.groboclown.retval.ProblemCollector
- isOk() - Method in interface net.groboclown.retval.ProblemContainer
-
Returns whether this object contains zero problems.
- isOk() - Method in class net.groboclown.retval.ValueAccumulator
- isOk() - Method in class net.groboclown.retval.ValueBuilder
- isOk() - Method in class net.groboclown.retval.WarningVal
- isProblem() - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- isProblem() - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- isProblem() - Method in class net.groboclown.retval.impl.MonitoredRetVoidOk
- isProblem() - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- isProblem() - Method in class net.groboclown.retval.impl.SimpleReturnValue
- isProblem() - Method in class net.groboclown.retval.impl.SimpleRetVoidOk
- isProblem() - Method in class net.groboclown.retval.ProblemCollector
- isProblem() - Method in interface net.groboclown.retval.ProblemContainer
-
Returns whether this object contains 1 or more problems.
- isProblem() - Method in class net.groboclown.retval.ValueAccumulator
- isProblem() - Method in class net.groboclown.retval.ValueBuilder
- isProblem() - Method in class net.groboclown.retval.WarningVal
- isTraceEnabled() - Method in class net.groboclown.retval.monitor.DebugObservedMonitor
- isTraceEnabled() - Method in class net.groboclown.retval.monitor.MockObservedMonitor
- isTraceEnabled() - Method in class net.groboclown.retval.monitor.NoOpObservedMonitor
- isTraceEnabled() - Method in interface net.groboclown.retval.monitor.ObservedMonitor
-
Is tracing enabled? If not enabled, then more memory efficient versions of objects may be used.
J
- joinProblemMessages(String, Collection<Problem>) - Static method in class net.groboclown.retval.Ret
-
Join the problem's
Problem.localMessage()text into a single string, joined by the joinText. - joinProblems(Problem, Problem...) - Static method in class net.groboclown.retval.Ret
-
Joins problems into a list of problems.
- joinProblemSets(Collection<Problem>, Collection<Problem>...) - Static method in class net.groboclown.retval.Ret
-
Join the array of lists of problems into a single list.
- joinProblemsWith(Collection<Problem>) - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- joinProblemsWith(Collection<Problem>) - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- joinProblemsWith(Collection<Problem>) - Method in class net.groboclown.retval.impl.MonitoredRetVoidOk
- joinProblemsWith(Collection<Problem>) - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- joinProblemsWith(Collection<Problem>) - Method in class net.groboclown.retval.impl.SimpleReturnValue
- joinProblemsWith(Collection<Problem>) - Method in class net.groboclown.retval.impl.SimpleRetVoidOk
- joinProblemsWith(Collection<Problem>) - Method in class net.groboclown.retval.ProblemCollector
- joinProblemsWith(Collection<Problem>) - Method in interface net.groboclown.retval.ProblemContainer
-
Add all problems in this container into the argument.
- joinProblemsWith(Collection<Problem>) - Method in class net.groboclown.retval.ValueAccumulator
- joinProblemsWith(Collection<Problem>) - Method in class net.groboclown.retval.ValueBuilder
- joinProblemsWith(Collection<Problem>) - Method in class net.groboclown.retval.WarningVal
- joinRetProblems(ProblemContainer, ProblemContainer...) - Static method in class net.groboclown.retval.Ret
-
Joins
ProblemContainerinstances into a list of problems. - joinRetProblemSets(Collection<ProblemContainer>, Collection<ProblemContainer>...) - Static method in class net.groboclown.retval.Ret
-
Joins problems in collections of
ProblemContainerinstances.
L
- LISTENER - Static variable in class net.groboclown.retval.monitor.NoOpObservedMonitor
- LocalizedProblem - Class in net.groboclown.retval.problems
-
Problem with a simple, localized message text.
- localMessage() - Method in interface net.groboclown.retval.Problem
-
A human-consumable message describing the problem.
- localMessage() - Method in class net.groboclown.retval.problems.FileProblem
- localMessage() - Method in class net.groboclown.retval.problems.LocalizedProblem
- localMessage() - Method in class net.groboclown.retval.problems.UnhandledExceptionProblem
- LoggingNotCompletedListener - Class in net.groboclown.retval.monitor
-
A listener that uses java.util.logging for the reporting.
M
- map(NonnullFunction<T, R>) - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- map(NonnullFunction<T, R>) - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- map(NonnullFunction<T, R>) - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- map(NonnullFunction<T, R>) - Method in class net.groboclown.retval.impl.SimpleReturnValue
- map(NonnullFunction<T, R>) - Method in interface net.groboclown.retval.RetVal
-
Return a non-null
RetValvalue, using a function that returns a non-null value, taking the current non-null value as an argument. - map(NonnullReturnFunction<T, R>) - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- map(NonnullReturnFunction<T, R>) - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- map(NonnullReturnFunction<T, R>) - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- map(NonnullReturnFunction<T, R>) - Method in class net.groboclown.retval.impl.SimpleReturnValue
- map(NonnullReturnFunction<T, R>) - Method in interface net.groboclown.retval.RetNullable
-
Return a non-null
RetValvalue, using a function that returns a non-null value, taking the current non-null value as an argument. - map(NonnullSupplier<R>) - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- map(NonnullSupplier<R>) - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- map(NonnullSupplier<R>) - Method in class net.groboclown.retval.impl.MonitoredRetVoidOk
- map(NonnullSupplier<R>) - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- map(NonnullSupplier<R>) - Method in class net.groboclown.retval.impl.SimpleRetVoidOk
- map(NonnullSupplier<R>) - Method in interface net.groboclown.retval.RetVoid
-
Return a non-null
RetValvalue using a supplier that returns a value. - mapNullable(Function<T, R>) - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- mapNullable(Function<T, R>) - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- mapNullable(Function<T, R>) - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- mapNullable(Function<T, R>) - Method in class net.groboclown.retval.impl.SimpleReturnValue
- mapNullable(Function<T, R>) - Method in interface net.groboclown.retval.RetNullable
-
If this instance has no problems, then it runs the parameter with the current value.
- mapNullable(Supplier<R>) - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- mapNullable(Supplier<R>) - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- mapNullable(Supplier<R>) - Method in class net.groboclown.retval.impl.MonitoredRetVoidOk
- mapNullable(Supplier<R>) - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- mapNullable(Supplier<R>) - Method in class net.groboclown.retval.impl.SimpleRetVoidOk
- mapNullable(Supplier<R>) - Method in interface net.groboclown.retval.RetVoid
-
Return a non-null
RetNullablevalue using a supplier that returns a value. - mapNullable(NonnullParamFunction<T, R>) - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- mapNullable(NonnullParamFunction<T, R>) - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- mapNullable(NonnullParamFunction<T, R>) - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- mapNullable(NonnullParamFunction<T, R>) - Method in class net.groboclown.retval.impl.SimpleReturnValue
- mapNullable(NonnullParamFunction<T, R>) - Method in interface net.groboclown.retval.RetVal
-
If this instance has no problems, then it runs the parameter with the current value.
- MockObservedMonitor<T> - Class in net.groboclown.retval.monitor
-
A mock check monitor, suitable for testing.
- MockObservedMonitor(ObservedMonitor<T>) - Constructor for class net.groboclown.retval.monitor.MockObservedMonitor
- MockObservedMonitor.Registered<T> - Class in net.groboclown.retval.monitor
-
Tracks the number of times the closeable is called.
- MockProblemMonitor - Class in net.groboclown.retval.monitor
-
A mock check monitor, suitable for testing.
- MonitoredFactory - Class in net.groboclown.retval.impl
-
Generates monitored versions of the return types.
- MonitoredReturnProblem<T> - Class in net.groboclown.retval.impl
-
A shared implementation of the Ret* interfaces, which only contains problems.
- MonitoredReturnValue<T> - Class in net.groboclown.retval.impl
-
Intended to be a version of the Ret* classes, with no error and a value.
- MonitoredRetVoidOk - Class in net.groboclown.retval.impl
-
Monitored version of RetVal with an ok state (no problems).
N
- net.groboclown.retval - package net.groboclown.retval
-
Combine values with problems associated with the values.
- net.groboclown.retval.env - package net.groboclown.retval.env
- net.groboclown.retval.function - package net.groboclown.retval.function
-
Functional interfaces that are null-aware.
- net.groboclown.retval.impl - package net.groboclown.retval.impl
-
Behind-the-scenes implementations for the top-level interfaces.
- net.groboclown.retval.monitor - package net.groboclown.retval.monitor
-
Monitors the error checking state of values created by this library.
- net.groboclown.retval.problems - package net.groboclown.retval.problems
-
Handy, pre-made problem types.
- NO_PROBLEMS - Static variable in class net.groboclown.retval.Ret
- NonnullBiConsumer<T,V> - Interface in net.groboclown.retval.function
-
An equivalent to
BiConsumer, where the parameters are non-null. - NonnullConsumer<T> - Interface in net.groboclown.retval.function
-
A version of
Consumerbut with an explicit nonnull value. - NonnullFirstBiConsumer<T,V> - Interface in net.groboclown.retval.function
-
An equivalent to
BiConsumer, where the first argument is non-null. - NonnullFunction<T,R> - Interface in net.groboclown.retval.function
-
A version of
Functionthat explicitly returns a non-null value, and takes a non-null parameter value. - NonnullParamFunction<T,R> - Interface in net.groboclown.retval.function
-
A version of the
Functioninterface where the parameter is explicitly non-null, and the return value is nullable. - NonnullReturnFunction<T,R> - Interface in net.groboclown.retval.function
-
A version of the
Functioninterface with an explicitly non-null return value, but nullable parameter value. - NonnullSupplier<T> - Interface in net.groboclown.retval.function
-
A version of the
Supplierinterface with an explicit non-null return value. - NonnullThrowsFunction<T,R> - Interface in net.groboclown.retval.function
-
A version of
Functionthat explicitly returns a non-null value, and takes a non-null parameter value, and throws exceptions. - NoOpObservedMonitor<T> - Class in net.groboclown.retval.monitor
-
A monitor that performs no actual monitoring.
- NotCompletedListener - Interface in net.groboclown.retval.monitor
-
A pluggable way to change out listening for notifications when a monitor detects that an object was not completed.
- nullableFromProblem(Collection<Problem>) - Static method in class net.groboclown.retval.impl.RetGenerator
-
Create a
RetNullableinstance with one or more problems. - nullableOk(T) - Static method in class net.groboclown.retval.impl.RetGenerator
-
Create a
RetNullableinstance with a value. - nullOrMap(NonnullParamFunction<T, R>) - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- nullOrMap(NonnullParamFunction<T, R>) - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- nullOrMap(NonnullParamFunction<T, R>) - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- nullOrMap(NonnullParamFunction<T, R>) - Method in class net.groboclown.retval.impl.SimpleReturnValue
- nullOrMap(NonnullParamFunction<T, R>) - Method in interface net.groboclown.retval.RetNullable
-
If this value has a problem, then it is returned.
- nullOrThenNullable(NonnullFunction<T, RetNullable<R>>) - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- nullOrThenNullable(NonnullFunction<T, RetNullable<R>>) - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- nullOrThenNullable(NonnullFunction<T, RetNullable<R>>) - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- nullOrThenNullable(NonnullFunction<T, RetNullable<R>>) - Method in class net.groboclown.retval.impl.SimpleReturnValue
- nullOrThenNullable(NonnullFunction<T, RetNullable<R>>) - Method in interface net.groboclown.retval.RetNullable
-
If this value has a problem, then it is returned.
O
- ObservedMonitor<T> - Interface in net.groboclown.retval.monitor
-
Tracks values that have requires certain calls made.
- ObservedMonitor.Listener - Interface in net.groboclown.retval.monitor
-
A listener into the closeable object to have it tell the monitor when various object lifecycle events take place.
- ObservedMonitorDetection - Class in net.groboclown.retval.env
-
Detects the startup implementation for the observation monitors.
- ObservedMonitorRegistrar - Class in net.groboclown.retval.monitor
-
A singleton that tracks values that have requirements around execution paths.
- ok() - Static method in interface net.groboclown.retval.RetVoid
-
Return a void object with no problems.
- ok(T) - Static method in interface net.groboclown.retval.RetNullable
-
Create a return object with a possibly null value and no problems.
- ok(T) - Static method in interface net.groboclown.retval.RetVal
-
Create a new RetVal instance that has a value and no problems.
- OK - Static variable in class net.groboclown.retval.impl.SimpleRetVoidOk
- onObserved() - Method in class net.groboclown.retval.monitor.MockObservedMonitor.Registered
- onObserved() - Method in interface net.groboclown.retval.monitor.ObservedMonitor.Listener
-
Called when the observable object has its specific action called.
P
- Problem - Interface in net.groboclown.retval
-
A standard problem that prevents a valid value from being returned.
- ProblemCollector - Class in net.groboclown.retval
-
Collects problems from multiple requests to gather data.
- ProblemContainer - Interface in net.groboclown.retval
-
An object that contains problems.
- produceVoid(NonnullFunction<T, RetVoid>) - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- produceVoid(NonnullFunction<T, RetVoid>) - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- produceVoid(NonnullFunction<T, RetVoid>) - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- produceVoid(NonnullFunction<T, RetVoid>) - Method in class net.groboclown.retval.impl.SimpleReturnValue
- produceVoid(NonnullFunction<T, RetVoid>) - Method in interface net.groboclown.retval.RetVal
-
Pass the value of this instance to the consumer, only if there are no problems.
- produceVoid(NonnullReturnFunction<T, RetVoid>) - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- produceVoid(NonnullReturnFunction<T, RetVoid>) - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- produceVoid(NonnullReturnFunction<T, RetVoid>) - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- produceVoid(NonnullReturnFunction<T, RetVoid>) - Method in class net.groboclown.retval.impl.SimpleReturnValue
- produceVoid(NonnullReturnFunction<T, RetVoid>) - Method in interface net.groboclown.retval.RetNullable
-
Pass the value of this instance to the consumer, only if there are no problems.
- produceVoidIfNonnull(NonnullFunction<T, RetVoid>) - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- produceVoidIfNonnull(NonnullFunction<T, RetVoid>) - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- produceVoidIfNonnull(NonnullFunction<T, RetVoid>) - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- produceVoidIfNonnull(NonnullFunction<T, RetVoid>) - Method in class net.groboclown.retval.impl.SimpleReturnValue
- produceVoidIfNonnull(NonnullFunction<T, RetVoid>) - Method in interface net.groboclown.retval.RetNullable
-
If this value has a problem, then it is returned as a
RetVoid.
R
- registerCheckedInstance(ProblemContainer) - Static method in class net.groboclown.retval.monitor.ObservedMonitorRegistrar
-
Register a new observable object with the monitor.
- registerInstance(T) - Method in class net.groboclown.retval.monitor.DebugObservedMonitor
- registerInstance(T) - Method in class net.groboclown.retval.monitor.MockObservedMonitor
- registerInstance(T) - Method in class net.groboclown.retval.monitor.NoOpObservedMonitor
- registerInstance(T) - Method in interface net.groboclown.retval.monitor.ObservedMonitor
-
Register a new observable object with the monitor.
- requireNonNull(Problem, Problem...) - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- requireNonNull(Problem, Problem...) - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- requireNonNull(Problem, Problem...) - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- requireNonNull(Problem, Problem...) - Method in class net.groboclown.retval.impl.SimpleReturnValue
- requireNonNull(Problem, Problem...) - Method in interface net.groboclown.retval.RetNullable
-
Require that this value contains a non-null value, otherwise produce a value with the problem arguments.
- requireOptional() - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- requireOptional() - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- requireOptional() - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- requireOptional() - Method in class net.groboclown.retval.impl.SimpleReturnValue
- requireOptional() - Method in interface net.groboclown.retval.RetNullable
-
Convert the value into an optional typed value only if there are no problems.
- requireOptional() - Method in interface net.groboclown.retval.RetVal
-
Convert the value into an optional typed value only if there are no problems.
- result() - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- result() - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- result() - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- result() - Method in class net.groboclown.retval.impl.SimpleReturnValue
- result() - Method in interface net.groboclown.retval.RetNullable
-
Get the result.
- result() - Method in interface net.groboclown.retval.RetVal
-
Get the result, which is always non-null.
- result(T) - Method in interface net.groboclown.retval.RetNullable
-
Get the stored value, or, if the stored value is null, return the non-null argument.
- Ret - Class in net.groboclown.retval
-
Utility class for working with collections of return values.
- RetGenerator - Class in net.groboclown.retval.impl
-
Central handler for creating Ret* instances.
- RetNullable<T> - Interface in net.groboclown.retval
-
A problem container that contains a nullable value or problems, but not both.
- ReturnTypeFactory - Interface in net.groboclown.retval.impl
-
An abstract factory pattern for creating the return type objects.
- ReturnTypeFactoryDetection - Class in net.groboclown.retval.env
-
Detects the return type factory implementation to use.
- RetVal<T> - Interface in net.groboclown.retval
-
A non-null value holder version of a problem container.
- RetVoid - Interface in net.groboclown.retval
-
A simple returnable that can have problems, but no value.
S
- setCheckedInstance(ObservedMonitor<ProblemContainer>) - Static method in class net.groboclown.retval.monitor.ObservedMonitorRegistrar
-
Allow for runtime replacement of the singleton.
- setFactory(ReturnTypeFactory) - Static method in class net.groboclown.retval.impl.RetGenerator
-
Allows for replacing the active return type factory.
- setup() - Static method in class net.groboclown.retval.monitor.MockProblemMonitor
-
Create a new mock monitor, and register it.
- SimpleFactory - Class in net.groboclown.retval.impl
-
Generates unmonitored, streamlined implementations.
- SimpleReturnProblem<T> - Class in net.groboclown.retval.impl
-
A shared implementation of the Ret* interfaces, which only contains problems and is not monitored.
- SimpleReturnValue<T> - Class in net.groboclown.retval.impl
-
Intended to be a version of the Ret* classes, with no error and a value, and has no monitor.
- SimpleRetVoidOk - Class in net.groboclown.retval.impl
-
Unmonitored version of RetVoid with an OK state.
- SourcedProblem - Interface in net.groboclown.retval
-
A problem that includes a known source.
T
- tearDown() - Method in class net.groboclown.retval.monitor.MockObservedMonitor
-
Tear down this monitor to the pre-setup state.
- tearDown() - Method in class net.groboclown.retval.monitor.MockProblemMonitor
-
De-register this monitor.
- then() - Method in class net.groboclown.retval.ValueAccumulator
-
Return a collection of the accumulated values, or the problems collected.
- then() - Method in class net.groboclown.retval.ValueBuilder
-
Convert this builder into a
RetVal; if any problems exist, then the returned object will have those problems, otherwise it will contain the value. - then(NonnullFunction<T, RetVal<R>>) - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- then(NonnullFunction<T, RetVal<R>>) - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- then(NonnullFunction<T, RetVal<R>>) - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- then(NonnullFunction<T, RetVal<R>>) - Method in class net.groboclown.retval.impl.SimpleReturnValue
- then(NonnullFunction<T, RetVal<R>>) - Method in interface net.groboclown.retval.RetVal
- then(NonnullReturnFunction<T, RetVal<R>>) - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- then(NonnullReturnFunction<T, RetVal<R>>) - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- then(NonnullReturnFunction<T, RetVal<R>>) - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- then(NonnullReturnFunction<T, RetVal<R>>) - Method in class net.groboclown.retval.impl.SimpleReturnValue
- then(NonnullReturnFunction<T, RetVal<R>>) - Method in interface net.groboclown.retval.RetNullable
- then(NonnullSupplier<RetVal<R>>) - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- then(NonnullSupplier<RetVal<R>>) - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- then(NonnullSupplier<RetVal<R>>) - Method in class net.groboclown.retval.impl.MonitoredRetVoidOk
- then(NonnullSupplier<RetVal<R>>) - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- then(NonnullSupplier<RetVal<R>>) - Method in class net.groboclown.retval.impl.SimpleRetVoidOk
- then(NonnullSupplier<RetVal<R>>) - Method in interface net.groboclown.retval.RetVoid
- then(NonnullSupplier<RetVal<T>>) - Method in class net.groboclown.retval.ProblemCollector
-
Generate a non-null value if this collector contains no problems, otherwise return the problems.
- thenNullable(NonnullFunction<T, RetNullable<R>>) - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- thenNullable(NonnullFunction<T, RetNullable<R>>) - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- thenNullable(NonnullFunction<T, RetNullable<R>>) - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- thenNullable(NonnullFunction<T, RetNullable<R>>) - Method in class net.groboclown.retval.impl.SimpleReturnValue
- thenNullable(NonnullFunction<T, RetNullable<R>>) - Method in interface net.groboclown.retval.RetVal
-
Return a non-null
RetNullablevalue using a function that itself returns aRetNullable, taking the current non-null value as an argument. - thenNullable(NonnullReturnFunction<T, RetNullable<R>>) - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- thenNullable(NonnullReturnFunction<T, RetNullable<R>>) - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- thenNullable(NonnullReturnFunction<T, RetNullable<R>>) - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- thenNullable(NonnullReturnFunction<T, RetNullable<R>>) - Method in class net.groboclown.retval.impl.SimpleReturnValue
- thenNullable(NonnullReturnFunction<T, RetNullable<R>>) - Method in interface net.groboclown.retval.RetNullable
-
Return a non-null
RetNullablevalue using a function that itself returns aRetNullable, taking the current non-null value as an argument. - thenNullable(NonnullSupplier<RetNullable<R>>) - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- thenNullable(NonnullSupplier<RetNullable<R>>) - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- thenNullable(NonnullSupplier<RetNullable<R>>) - Method in class net.groboclown.retval.impl.MonitoredRetVoidOk
- thenNullable(NonnullSupplier<RetNullable<R>>) - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- thenNullable(NonnullSupplier<RetNullable<R>>) - Method in class net.groboclown.retval.impl.SimpleRetVoidOk
- thenNullable(NonnullSupplier<RetNullable<R>>) - Method in interface net.groboclown.retval.RetVoid
-
If there is no problem, run the supplier and return its value.
- thenNullable(NonnullSupplier<RetNullable<T>>) - Method in class net.groboclown.retval.ProblemCollector
-
Generate a nullable value if this collector contains no problems, otherwise return the problems.
- thenNullableValue(Supplier<T>) - Method in class net.groboclown.retval.ProblemCollector
-
Generate a nullable value if this collector contains no problems, otherwise return the problems.
- thenRun(Runnable) - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- thenRun(Runnable) - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- thenRun(Runnable) - Method in class net.groboclown.retval.impl.MonitoredRetVoidOk
- thenRun(Runnable) - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- thenRun(Runnable) - Method in class net.groboclown.retval.impl.SimpleReturnValue
- thenRun(Runnable) - Method in class net.groboclown.retval.impl.SimpleRetVoidOk
- thenRun(Runnable) - Method in class net.groboclown.retval.ProblemCollector
-
If this collector has no problems, then run the runner and return a void value.
- thenRun(Runnable) - Method in interface net.groboclown.retval.RetVal
-
Run the parameter, only if this instance has no problems.
- thenRun(Runnable) - Method in interface net.groboclown.retval.RetVoid
-
Run the runnable if there is no problem.
- thenRun(NonnullConsumer<T>) - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- thenRun(NonnullConsumer<T>) - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- thenRun(NonnullConsumer<T>) - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- thenRun(NonnullConsumer<T>) - Method in class net.groboclown.retval.impl.SimpleReturnValue
- thenRun(NonnullConsumer<T>) - Method in interface net.groboclown.retval.RetVal
-
Run the consumer with the current value, only if this instance has no problems.
- thenRunNullable(Runnable) - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- thenRunNullable(Runnable) - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- thenRunNullable(Runnable) - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- thenRunNullable(Runnable) - Method in class net.groboclown.retval.impl.SimpleReturnValue
- thenRunNullable(Runnable) - Method in interface net.groboclown.retval.RetNullable
-
Run the parameter, only if this instance has no problems.
- thenRunNullable(Consumer<T>) - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- thenRunNullable(Consumer<T>) - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- thenRunNullable(Consumer<T>) - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- thenRunNullable(Consumer<T>) - Method in class net.groboclown.retval.impl.SimpleReturnValue
- thenRunNullable(Consumer<T>) - Method in interface net.groboclown.retval.RetNullable
-
Run the consumer with the current value, only if this instance has no problems.
- thenValidate(Function<T, ProblemContainer>) - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- thenValidate(Function<T, ProblemContainer>) - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- thenValidate(Function<T, ProblemContainer>) - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- thenValidate(Function<T, ProblemContainer>) - Method in class net.groboclown.retval.impl.SimpleReturnValue
- thenValidate(Function<T, ProblemContainer>) - Method in interface net.groboclown.retval.RetNullable
-
Validate the value in the checker.
- thenValidate(NonnullParamFunction<T, ProblemContainer>) - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- thenValidate(NonnullParamFunction<T, ProblemContainer>) - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- thenValidate(NonnullParamFunction<T, ProblemContainer>) - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- thenValidate(NonnullParamFunction<T, ProblemContainer>) - Method in class net.groboclown.retval.impl.SimpleReturnValue
- thenValidate(NonnullParamFunction<T, ProblemContainer>) - Method in interface net.groboclown.retval.RetVal
-
Validate the value in the checker.
- thenValue(NonnullSupplier<T>) - Method in class net.groboclown.retval.ProblemCollector
-
Generate a non-null value if this collector contains no problems, otherwise return the problems.
- thenVoid(Consumer<T>) - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- thenVoid(Consumer<T>) - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- thenVoid(Consumer<T>) - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- thenVoid(Consumer<T>) - Method in class net.groboclown.retval.impl.SimpleReturnValue
- thenVoid(Consumer<T>) - Method in interface net.groboclown.retval.RetNullable
-
Pass the value of this instance to the consumer, only if there are no problems.
- thenVoid(NonnullConsumer<T>) - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- thenVoid(NonnullConsumer<T>) - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- thenVoid(NonnullConsumer<T>) - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- thenVoid(NonnullConsumer<T>) - Method in class net.groboclown.retval.impl.SimpleReturnValue
- thenVoid(NonnullConsumer<T>) - Method in interface net.groboclown.retval.RetVal
-
Pass the value of this instance to the consumer, only if there are no problems.
- thenVoid(NonnullFunction<T, RetVoid>) - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- thenVoid(NonnullFunction<T, RetVoid>) - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- thenVoid(NonnullFunction<T, RetVoid>) - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- thenVoid(NonnullFunction<T, RetVoid>) - Method in class net.groboclown.retval.impl.SimpleReturnValue
- thenVoid(NonnullFunction<T, RetVoid>) - Method in interface net.groboclown.retval.RetVal
-
Pass the value of this instance to the function, only if there are no problems.
- thenVoid(NonnullReturnFunction<T, RetVoid>) - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- thenVoid(NonnullReturnFunction<T, RetVoid>) - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- thenVoid(NonnullReturnFunction<T, RetVoid>) - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- thenVoid(NonnullReturnFunction<T, RetVoid>) - Method in class net.groboclown.retval.impl.SimpleReturnValue
- thenVoid(NonnullReturnFunction<T, RetVoid>) - Method in interface net.groboclown.retval.RetNullable
-
Pass the value of this instance to the consumer, only if there are no problems.
- thenVoid(NonnullSupplier<RetVoid>) - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- thenVoid(NonnullSupplier<RetVoid>) - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- thenVoid(NonnullSupplier<RetVoid>) - Method in class net.groboclown.retval.impl.MonitoredRetVoidOk
- thenVoid(NonnullSupplier<RetVoid>) - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- thenVoid(NonnullSupplier<RetVoid>) - Method in class net.groboclown.retval.impl.SimpleRetVoidOk
- thenVoid(NonnullSupplier<RetVoid>) - Method in interface net.groboclown.retval.RetVoid
-
Return the supplier if there is no problem.
- toString() - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- toString() - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- toString() - Method in class net.groboclown.retval.impl.MonitoredRetVoidOk
- toString() - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- toString() - Method in class net.groboclown.retval.impl.SimpleReturnValue
- toString() - Method in class net.groboclown.retval.impl.SimpleRetVoidOk
- toString() - Method in class net.groboclown.retval.problems.FileProblem
- toString() - Method in class net.groboclown.retval.problems.LocalizedProblem
- toString() - Method in class net.groboclown.retval.problems.UnhandledExceptionProblem
- traceEnabled - Variable in class net.groboclown.retval.monitor.MockObservedMonitor
U
- UnhandledExceptionProblem - Class in net.groboclown.retval.problems
-
A problem that comes from an exception that wasn't properly handled.
V
- valFromProblem(Collection<Problem>) - Static method in class net.groboclown.retval.impl.RetGenerator
-
Create a new RetVal instance that has errors.
- validateEach(Collection<T>, Function<T, ProblemContainer>) - Method in class net.groboclown.retval.ProblemCollector
-
For each item in the values collection, the function is called, giving it a chance to return problems associated with the value.
- validProblems() - Method in class net.groboclown.retval.impl.MonitoredReturnProblem
- validProblems() - Method in class net.groboclown.retval.impl.MonitoredReturnValue
- validProblems() - Method in class net.groboclown.retval.impl.MonitoredRetVoidOk
- validProblems() - Method in class net.groboclown.retval.impl.SimpleReturnProblem
- validProblems() - Method in class net.groboclown.retval.impl.SimpleReturnValue
- validProblems() - Method in class net.groboclown.retval.impl.SimpleRetVoidOk
- validProblems() - Method in class net.groboclown.retval.ProblemCollector
- validProblems() - Method in interface net.groboclown.retval.ProblemContainer
-
Returns all contained problems in this object, but only if this object contains 1 or more problems.
- validProblems() - Method in class net.groboclown.retval.ValueAccumulator
- validProblems() - Method in class net.groboclown.retval.ValueBuilder
- validProblems() - Method in class net.groboclown.retval.WarningVal
- valOk(T) - Static method in class net.groboclown.retval.impl.RetGenerator
-
Create a new RetVal instance that has a value and no problems.
- ValueAccumulator<T> - Class in net.groboclown.retval
-
Allows for accumulating a list of values, some of which may have errors associated with them.
- ValueBuilder<T> - Class in net.groboclown.retval
-
Contains a non-null value and accumulates problems as aspects of the value are updated.
- ValuedProblemContainer<T> - Interface in net.groboclown.retval
-
A generic type that contains a value and possible problems.
- voidFromProblem(Collection<Problem>) - Static method in class net.groboclown.retval.impl.RetGenerator
-
Constructs a
RetVoidinstance with the collections of problems. - voidOk() - Static method in class net.groboclown.retval.impl.RetGenerator
-
Return a void object with no problems.
W
- WarningVal<T> - Class in net.groboclown.retval
-
A container for a non-null value and associated problems.
- wasObserved() - Method in class net.groboclown.retval.monitor.MockObservedMonitor.Registered
-
Return if this closeable object had the
MockObservedMonitor.Registered.onObserved()()} method called. - with(Collection<Problem>, Collection<Problem>...) - Method in class net.groboclown.retval.ValueAccumulator
-
Add the given possible problems to the accumulator.
- with(Problem, Problem...) - Method in class net.groboclown.retval.ValueAccumulator
-
Add the given possible problems to the accumulator.
- with(RetNullable<T>) - Method in class net.groboclown.retval.ValueAccumulator
-
Add the given value or problems to this accumulator.
- with(RetNullable<T>, Consumer<T>) - Method in class net.groboclown.retval.ProblemCollector
-
If the value has problems, load them into this collector, otherwise pass the value as an argument to the setter.
- with(RetNullable<V>, NonnullFirstBiConsumer<T, V>) - Method in class net.groboclown.retval.ValueBuilder
-
Calls the consumer with arguments
(getValue(), arg.result())if arg has no problems. - with(RetVal<T>) - Method in class net.groboclown.retval.ValueAccumulator
-
Add the given value or problems to this accumulator.
- with(RetVal<T>, NonnullConsumer<T>) - Method in class net.groboclown.retval.ProblemCollector
-
If the value has problems, load them into this collector, otherwise pass the value as an argument to the setter.
- with(RetVal<V>, NonnullBiConsumer<T, V>) - Method in class net.groboclown.retval.ValueBuilder
-
Calls the consumer with arguments
(getValue(), arg.result())if arg has no problems. - with(RetVoid) - Method in class net.groboclown.retval.ProblemCollector
-
Add in any problems from the value into this collector.
- with(RetVoid) - Method in class net.groboclown.retval.ValueBuilder
-
Join any problems in the argument with this builder.
- with(WarningVal<T>, NonnullConsumer<T>) - Method in class net.groboclown.retval.ProblemCollector
-
If the value has problems, load them into this collector.
- withAll(Iterable<RetVoid>) - Method in class net.groboclown.retval.ProblemCollector
-
Add into this collector any problems from each of the values.
- withAll(RetNullable<? extends Iterable<T>>) - Method in class net.groboclown.retval.ValueAccumulator
-
If the argument is okay, then all the entries in the value are added into this accumulator (but only if the value is non-null).
- withAll(RetVal<? extends Iterable<T>>) - Method in class net.groboclown.retval.ValueAccumulator
-
If the argument is okay, then all the entries in the value are added into this accumulator.
- withAll(RetVoid...) - Method in class net.groboclown.retval.ProblemCollector
-
Add into this collector any problems from each of the values.
- withAllValues(Iterable<T>...) - Method in class net.groboclown.retval.ValueAccumulator
-
Add vararg list of values into this accumulator.
- withAllValues(T...) - Method in class net.groboclown.retval.ValueAccumulator
-
Add vararg list of values into this accumulator.
- withEach(Collection<V>, NonnullReturnFunction<V, RetVal<T>>) - Method in class net.groboclown.retval.ValueAccumulator
-
For each element in the input list, process it through the function argument to transform into the accumulator type.
- withEach(RetVal<? extends Collection<V>>, NonnullReturnFunction<V, RetVal<T>>) - Method in class net.groboclown.retval.ValueAccumulator
-
For each element in the input list, process it through the function argument to transform into the accumulator type.
- withProblem(Problem, Problem...) - Method in class net.groboclown.retval.ProblemCollector
-
Adds all the problems in the argument into this collector.
- withProblems(Collection<Problem>, Collection<Problem>...) - Method in class net.groboclown.retval.ProblemCollector
-
Adds all the problems in the argument into this collector.
- withValue(NonnullConsumer<T>) - Method in class net.groboclown.retval.ValueBuilder
-
Call the consumer with the current value; commonly used to set a single, no-problem attribute on the value.
- withValuedProblemContainer(ValuedProblemContainer<T>, Consumer<T>) - Method in class net.groboclown.retval.ProblemCollector
-
If the value has problems, load them into this collector, otherwise pass the value as an argument to the setter.
- wrap(Throwable) - Static method in class net.groboclown.retval.problems.UnhandledExceptionProblem
-
Create an
UnhandledExceptionProblemfrom an exception.