Package net.adamcin.oakpal.api

Interface Summary

Interface	Description
ApiConstants.ViolationKeys	Json key constant accessors for violations.
Fun.ThrowingBiConsumer<K,V>	Inferrable type for BiConsumers that throw.
Fun.ThrowingBiFunction<K,V,R>	Inferrable type for BiFunctions that throw.
Fun.ThrowingBiPredicate<K,V>	Inferrable type for BiPredicates that throw.
Fun.ThrowingConsumer<T>	Inferrable type for Consumers that throw.
Fun.ThrowingFunction<T,R>	Inferrable type for Functions that throw.
Fun.ThrowingPredicate<T>	Inferrable type for Predicates that throw
Fun.ThrowingSupplier<R>	Inferrable type for Suppliers that throw.
JavaxJson.As<TYPE>	Defines a get method returns the constructed type parameter.
JavaxJson.Cursor	Type which allows a different fluent style for building keys, i.e.
JavaxJson.HasValue	Defines a method toValue which coalesces the underlying value to prevent over-wrapping by the JavaxJson.val(Object) method.
JsonArrayConvertible	Custom pojo types which should be usable within the JavaxJson DSL should implement this method to provide a JsonArray, which can be wrapped quickly by JavaxJson.val(Object).
JsonObjectConvertible	Custom pojo types which should be usable within the JavaxJson DSL should implement this method to provide a JsonObject, which can be wrapped quickly by JavaxJson.val(Object).
ProgressCheck	Primary point of customization for the OakPAL framework.
ProgressCheckFactory	A factory for creating ProgressChecks that accepts a config map.
Rule.JsonKeys
ScanListener	Defines listener notifications for beginning and end of scan common to ProgressCheck and ErrorListener.
Violation	Report type for validations.
ViolationReporter	Base interface for violation reporters.

Class Summary

Class	Description
ApiConstants	Hosts constants as static singleton getter methods defined by interfaces.
Fun	This alphabet soup provides function transformation methods targeting usage within Java 8+ Streams.
JavaxJson	Simple DSL for constructing javax.json objects for ProgressCheckFactory configs using only three-letter identifiers.
JavaxJson.Arr	Constructs an array by iterating over a list of JavaxJson.Value instances.
JavaxJson.Key	Iterative key-value pair type for building JavaxJson.Obj instances.
JavaxJson.KeyCursor	Cursor type originating from a call to JavaxJson.key(String), and which therefore returns a lone JavaxJson.Key for JavaxJson.KeyCursor.val(Object).
JavaxJson.Obj	Constructs an object by iterating over a list of JavaxJson.Key instances.
JavaxJson.ObjCursor	Cursor type originating from a call to JavaxJson.Key.key(String) or JavaxJson.Obj.key(String), and which therefore returns a new JavaxJson.Obj with the newly-finished key appended internally.
JavaxJson.Value	Discrete value wrapper.
Nothing	A sentinel type for functional parameters representing Nothing, like Void.
ReportCollector	Simple collector of violations for use by ProgressCheck implementations.
Result<V>	A type representing either a successful result value, or failure, with an error.
Result.Builder<V,A>	Builds a result for a wrapped collector.
Rule	Standard Rule tuple capturing a rule type (include/exclude or allow/deny) and a regex pattern.
Rules	Factory methods and defaults for Rule.
SimpleProgressCheck	Simple implementation of a ProgressCheck with convenient methods for reporting and collecting violations.
SimpleProgressCheckFactoryCheck<FACTORY extends ProgressCheckFactory>	Convenience type for simple progress checks that are identified by their factory.
SimpleViolation	Simple implementation of a Violation.
SimpleViolation.Builder

Enum Summary

Enum	Description
PathAction	Enumeration of progress tracker path import action types.
RuleType	Type for a Rule.
Severity	Levels of severity for violations detected during package scans.

Exception Summary

Exception	Description
Fun.FunRuntimeException	Wrapping runtime error type for unchecked throwing functions.