Skip navigation links
A B C D E F G H I J K L M N O P R S T U V W Z 

A

accept(Result<V>) - Method in class net.adamcin.oakpal.api.Result.Builder
 
afterExtract(PackageId, Session) - Method in interface net.adamcin.oakpal.api.ProgressCheck
Provides an opportunity to inspect repository state between packages.
and(Object...) - Method in class net.adamcin.oakpal.api.JavaxJson.Arr
 
and(JavaxJson.Key...) - Method in class net.adamcin.oakpal.api.JavaxJson.Obj
Append more JavaxJson.Key instances.
and(Map<?, ?>) - Method in class net.adamcin.oakpal.api.JavaxJson.Obj
Append the entries in map as JavaxJson.Key instances.
ApiConstants - Class in net.adamcin.oakpal.api
Hosts constants as static singleton getter methods defined by interfaces.
ApiConstants.ViolationKeys - Interface in net.adamcin.oakpal.api
Json key constant accessors for violations.
arr(Object...) - Static method in class net.adamcin.oakpal.api.JavaxJson
Creates an array with the provided values.
arrayOrEmpty(JsonObject, String) - Static method in class net.adamcin.oakpal.api.JavaxJson
Retrieve a value as an array, or return the empty array if key is not present or if the value is the wrong type.
arrKeys() - Method in class net.adamcin.oakpal.api.JavaxJson.Obj
Transform to an array consisting of the object keys, un-deduplicated.
arrVals() - Method in class net.adamcin.oakpal.api.JavaxJson.Obj
Transform to an array consisting of the object values.

B

beforeExtract(PackageId, Session, PackageProperties, MetaInf, List<PackageId>) - Method in interface net.adamcin.oakpal.api.ProgressCheck
Called for each package before it is extracted.
build() - Method in class net.adamcin.oakpal.api.SimpleViolation.Builder
Build a simple violation.
builder() - Static method in class net.adamcin.oakpal.api.SimpleViolation
Use this builder method to more easily construct a violation with MessageFormat arguments.
builder(ResourceBundle) - Static method in class net.adamcin.oakpal.api.SimpleViolation
Use this builder method to more easily construct a violation with MessageFormat arguments.
byName(String) - Static method in enum net.adamcin.oakpal.api.Severity
Runtime throwing function to lookup severity codes by name.

C

canGetItem() - Method in enum net.adamcin.oakpal.api.PathAction
Returns true if it is safe to get the item at the referenced path based on this action type.
clearViolations() - Method in class net.adamcin.oakpal.api.ReportCollector
 
collector - Variable in class net.adamcin.oakpal.api.SimpleProgressCheck
 
combine(Nothing) - Method in class net.adamcin.oakpal.api.Nothing
 
compose0(Supplier<? extends R>, Function<? super R, ? extends S>) - Static method in class net.adamcin.oakpal.api.Fun
Compose a Supplier with a Function that maps the original supplied type to a new supplied type.
compose1(Function<T, ? extends I>, Function<? super I, ? extends R>) - Static method in class net.adamcin.oakpal.api.Fun
Essentially the same as calling Function.andThen(Function), except needing no cast for a method reference as the before argument, resulting in function composition of before followed by after.
compose2(BiFunction<K, V, ? extends I>, Function<? super I, ? extends R>) - Static method in class net.adamcin.oakpal.api.Fun
Essentially the same as calling BiFunction.andThen(Function), except needing no cast for a method reference as the before argument, resulting in function composition of before followed by after.
composeTest1(Function<? super T, ? extends P>, Predicate<? super P>) - Static method in class net.adamcin.oakpal.api.Fun
Compose a Predicate with a preceding input Function that maps the stream element type to the input type of the Predicate.
composeTest2(Function<? super K, ? extends P>, Function<? super V, ? extends Q>, BiPredicate<? super P, ? super Q>) - Static method in class net.adamcin.oakpal.api.Fun
Compose a BiPredicate with preceding left and right input Functions that map the stream Entry element key and value types to the respective input type of the provided BiPredicate.
composeTest2(BiFunction<? super K, ? super V, ? extends P>, Predicate<? super P>) - Static method in class net.adamcin.oakpal.api.Fun
Compose a BiPredicate with a single preceding BiFunction that maps the stream Entry element key and value types to the input type of the provided Predicate.
composeTry0(Function<? super R, ? extends M>, Supplier<? extends M>, Fun.ThrowingSupplier<? extends R>, Consumer<? super Exception>) - Static method in class net.adamcin.oakpal.api.Fun
Composes four lambdas into a single supplier for use with flatMap() defined by Stream, Optional, etc.
composeTry0(Function<? super R, ? extends M>, Function<? super Exception, ? extends M>, Fun.ThrowingSupplier<? extends R>) - Static method in class net.adamcin.oakpal.api.Fun
Composes four lambdas into a single supplier for use with flatMap() defined by Stream, Optional, etc.
composeTry1(Function<? super R, ? extends M>, Supplier<? extends M>, Fun.ThrowingFunction<? super T, ? extends R>, BiConsumer<? super T, ? super Exception>) - Static method in class net.adamcin.oakpal.api.Fun
Composes four lambdas into a single function for use with flatMap() defined by Stream, Optional, etc.
composeTry1(Function<? super R, ? extends M>, Function<? super Exception, ? extends M>, Fun.ThrowingFunction<? super T, ? extends R>) - Static method in class net.adamcin.oakpal.api.Fun
Composes four lambdas into a single function for use with flatMap() defined by Stream, Optional, etc.
composeTry2(Function<? super R, ? extends M>, Supplier<? extends M>, Fun.ThrowingBiFunction<? super K, ? super V, ? extends R>, BiConsumer<? super Map.Entry<? super K, ? super V>, ? super Exception>) - Static method in class net.adamcin.oakpal.api.Fun
Composes four lambdas into a single bifunction for use with flatMap() defined by Stream, Optional, etc.
composeTry2(Function<? super R, ? extends M>, Function<? super Exception, ? extends M>, Fun.ThrowingBiFunction<? super K, ? super V, ? extends R>) - Static method in class net.adamcin.oakpal.api.Fun
Composes four lambdas into a single function for use with flatMap() defined by Stream, Optional, etc.
constantly1(Supplier<? extends R>) - Static method in class net.adamcin.oakpal.api.Fun
Fits a supplier into a pipeline as a constant Function.
constantly2(Supplier<? extends R>) - Static method in class net.adamcin.oakpal.api.Fun
Fits a supplier into a pipeline as a constant BiFunction.

D

DEFAULT_ALLOW - Static variable in class net.adamcin.oakpal.api.Rules
A default ALLOW rule that matches everything.
DEFAULT_DENY - Static variable in class net.adamcin.oakpal.api.Rules
A default DENY rule that matches everything.
DEFAULT_EXCLUDE - Static variable in class net.adamcin.oakpal.api.Rules
A default EXCLUDE rule that matches everything.
DEFAULT_INCLUDE - Static variable in class net.adamcin.oakpal.api.Rules
A default INCLUDE rule that matches everything.
deletedPath(PackageId, String, Session) - Method in interface net.adamcin.oakpal.api.ProgressCheck
Notified when package importer deletes an existing node.
description() - Method in interface net.adamcin.oakpal.api.ApiConstants.ViolationKeys
 

E

entriesToMap() - Static method in class net.adamcin.oakpal.api.Fun
Shorthand for Collectors.toMap(Function, Function) for collecting streams of Map.Entry, except using Fun.keepLastMerger() as the merge function, and LinkedHashMap as the supplied map type.
entriesToMap(BinaryOperator<V>) - Static method in class net.adamcin.oakpal.api.Fun
Shorthand for Collectors.toMap(Function, Function, BinaryOperator, Supplier) for collecting streams of Map.Entry, except using LinkedHashMap as the supplied map type.
entriesToMapOfType(Supplier<Map<K, V>>) - Static method in class net.adamcin.oakpal.api.Fun
Shorthand for Collectors.toMap(Function, Function, BinaryOperator, Supplier) for collecting streams of Map.Entry, except using Fun.keepLastMerger() as the merge function.
entriesToMapOfType(Supplier<Map<K, V>>, BinaryOperator<V>) - Static method in class net.adamcin.oakpal.api.Fun
Shorthand for Collectors.toMap(Function, Function, BinaryOperator, Supplier) for collecting streams of Map.Entry.
entryTee(BiConsumer<? super K, ? super V>) - Static method in class net.adamcin.oakpal.api.Fun
Like Fun.tee(Consumer), this method transforms a BiConsumer into a "tee" (like the Unix command, evoking the shape of the letter, 'T') function for Map.Entry streams, that passes the input entry to output after calling BiConsumer.accept(Object, Object) with the input entry key and value.
equals(Object) - Method in class net.adamcin.oakpal.api.Rule
 
equals(Object) - Method in class net.adamcin.oakpal.api.SimpleViolation
 

F

failure(String) - Static method in class net.adamcin.oakpal.api.Result
 
failure(Exception) - Static method in class net.adamcin.oakpal.api.Result
 
failure(String, Exception) - Static method in class net.adamcin.oakpal.api.Result
 
failure(RuntimeException) - Static method in class net.adamcin.oakpal.api.Result
 
findCause(Predicate<? super Throwable>) - Method in class net.adamcin.oakpal.api.Result
Filters the exception stack as a stream using the provided Throwable predicate.
findCause(Class<E>) - Method in class net.adamcin.oakpal.api.Result
Filters the exception stack as a stream, matching causes against the provided error type.
finishedScan() - Method in interface net.adamcin.oakpal.api.ScanListener
Called once at the end of the scan to notify for cleanup of resources.
flatMap(Function<? super V, Result<W>>) - Method in class net.adamcin.oakpal.api.Result
Flat-map it.
forEach(Consumer<? super V>) - Method in class net.adamcin.oakpal.api.Result
Standard forEach method calling a consumer to accept the value.
fromJson(JsonObject) - Static method in class net.adamcin.oakpal.api.Rules
Construct a single rule from a JSON object with keys type and pattern.
fromJson(JsonObject) - Static method in class net.adamcin.oakpal.api.SimpleViolation
 
fromJsonArray(JsonArray) - Static method in class net.adamcin.oakpal.api.Rules
Conveniently creates a list of Rules from the conventional use case of a JSON array containing a list of rule JSON objects to be evaluated in sequence.
fromName(String) - Static method in enum net.adamcin.oakpal.api.RuleType
 
fromReported(Violation) - Static method in class net.adamcin.oakpal.api.SimpleViolation
 
fromShortCode(String) - Static method in enum net.adamcin.oakpal.api.PathAction
Lookup an action type by the short code.
Fun - Class in net.adamcin.oakpal.api
This alphabet soup provides function transformation methods targeting usage within Java 8+ Streams.
Fun.FunRuntimeException - Exception in net.adamcin.oakpal.api
Wrapping runtime error type for unchecked throwing functions.
Fun.ThrowingBiConsumer<K,V> - Interface in net.adamcin.oakpal.api
Inferrable type for BiConsumers that throw.
Fun.ThrowingBiFunction<K,V,R> - Interface in net.adamcin.oakpal.api
Inferrable type for BiFunctions that throw.
Fun.ThrowingBiPredicate<K,V> - Interface in net.adamcin.oakpal.api
Inferrable type for BiPredicates that throw.
Fun.ThrowingConsumer<T> - Interface in net.adamcin.oakpal.api
Inferrable type for Consumers that throw.
Fun.ThrowingFunction<T,R> - Interface in net.adamcin.oakpal.api
Inferrable type for Functions that throw.
Fun.ThrowingPredicate<T> - Interface in net.adamcin.oakpal.api
Inferrable type for Predicates that throw
Fun.ThrowingSupplier<R> - Interface in net.adamcin.oakpal.api
Inferrable type for Suppliers that throw.
fuzzyDefaultAllow(List<Rule>) - Static method in class net.adamcin.oakpal.api.Rules
Return Rules.DEFAULT_ALLOW, unless first element in rules list is an explicit allow, in which case return Rules.DEFAULT_DENY.
fuzzyDefaultDeny(List<Rule>) - Static method in class net.adamcin.oakpal.api.Rules
Return Rules.DEFAULT_DENY, unless first element in rules list is an explicit deny, in which case return Rules.DEFAULT_ALLOW.
fuzzyDefaultExclude(List<Rule>) - Static method in class net.adamcin.oakpal.api.Rules
Return Rules.DEFAULT_EXCLUDE, unless first element in rules list is an explicit exclude, in which case return Rules.DEFAULT_INCLUDE.
fuzzyDefaultInclude(List<Rule>) - Static method in class net.adamcin.oakpal.api.Rules
Return Rules.DEFAULT_INCLUDE, unless first element in rules list is an explicit include, in which case return Rules.DEFAULT_EXCLUDE.

G

get() - Method in class net.adamcin.oakpal.api.JavaxJson.Arr
 
get() - Method in interface net.adamcin.oakpal.api.JavaxJson.As
 
get() - Method in class net.adamcin.oakpal.api.JavaxJson.Key
 
get() - Method in class net.adamcin.oakpal.api.JavaxJson.Obj
Builds a new JsonObject instance putting all the key value pairs in order.
get() - Method in class net.adamcin.oakpal.api.JavaxJson.Value
 
getCheckName() - Method in interface net.adamcin.oakpal.api.ProgressCheck
Return an optional label for displaying reports made by this reporter.
getCheckName() - Method in class net.adamcin.oakpal.api.SimpleProgressCheckFactoryCheck
 
getDescription() - Method in class net.adamcin.oakpal.api.SimpleViolation
 
getDescription() - Method in interface net.adamcin.oakpal.api.Violation
Describes the nature of the violation.
getError() - Method in class net.adamcin.oakpal.api.Result
All Failures will be created with a top-level RuntimeException.
getKey() - Method in interface net.adamcin.oakpal.api.JavaxJson.Cursor
 
getKey() - Method in class net.adamcin.oakpal.api.JavaxJson.KeyCursor
 
getKey() - Method in class net.adamcin.oakpal.api.JavaxJson.ObjCursor
 
getObj() - Method in class net.adamcin.oakpal.api.JavaxJson.ObjCursor
 
getOrDefault(V) - Method in class net.adamcin.oakpal.api.Result
 
getOrElse(Supplier<? extends V>) - Method in class net.adamcin.oakpal.api.Result
 
getPackages() - Method in class net.adamcin.oakpal.api.SimpleViolation
 
getPackages() - Method in interface net.adamcin.oakpal.api.Violation
Provides a list of one or more Packages responsible for the violation.
getPattern() - Method in class net.adamcin.oakpal.api.Rule
 
getReportedViolations() - Method in class net.adamcin.oakpal.api.ReportCollector
 
getReportedViolations() - Method in class net.adamcin.oakpal.api.SimpleProgressCheck
 
getReportedViolations() - Method in interface net.adamcin.oakpal.api.ViolationReporter
Called at the end of execution to collect any detected violations.
getResourceBundle() - Method in class net.adamcin.oakpal.api.SimpleProgressCheck
Used by SimpleProgressCheck.getString(String) to retrieve localized messages.
getResourceBundleBaseName() - Method in class net.adamcin.oakpal.api.SimpleProgressCheckFactoryCheck
 
getResourceBundleBaseName() - Method in interface net.adamcin.oakpal.api.ViolationReporter
Get the resource bundle base name for loading the default resource bundle for this violation reporter.
getSeverity() - Method in class net.adamcin.oakpal.api.SimpleViolation
 
getSeverity() - Method in interface net.adamcin.oakpal.api.Violation
Describe the severity of the violation.
getShortCode() - Method in enum net.adamcin.oakpal.api.PathAction
Get the short code reported by filevault.
getString(String) - Method in class net.adamcin.oakpal.api.SimpleProgressCheck
Lookup a localized string from the resource bundle.
getType() - Method in class net.adamcin.oakpal.api.Rule
 

H

hashCode() - Method in class net.adamcin.oakpal.api.Rule
 
hashCode() - Method in class net.adamcin.oakpal.api.SimpleViolation
 
hasNonNull(JsonObject, String) - Static method in class net.adamcin.oakpal.api.JavaxJson
Convenience method to check to avoid type errors when getting a typed value backed by a JsonValue.NULL.

I

identifyPackage(PackageId, File) - Method in interface net.adamcin.oakpal.api.ProgressCheck
Called after the package is uploaded to the package manager at the beginning of the scan.
identifySubpackage(PackageId, PackageId) - Method in interface net.adamcin.oakpal.api.ProgressCheck
Called after each subpackage is opened.
importedPath(PackageId, String, Node) - Method in interface net.adamcin.oakpal.api.ProgressCheck
importedPath(PackageId, String, Node, PathAction) - Method in interface net.adamcin.oakpal.api.ProgressCheck
Notified when package importer adds, modifies, or leaves a node untouched.
infer0(Supplier<? extends T>) - Static method in class net.adamcin.oakpal.api.Fun
Infers a method ref to a Supplier.
infer1(Function<? super T, ? extends R>) - Static method in class net.adamcin.oakpal.api.Fun
Infers a static method ref to a Function.
infer2(BiFunction<? super K, ? super V, ? extends R>) - Static method in class net.adamcin.oakpal.api.Fun
Infers a static method ref to a BiFunction.
inferTest1(Predicate<? super T>) - Static method in class net.adamcin.oakpal.api.Fun
Infers a method ref to a Predicate.
inferTest2(BiPredicate<? super K, ? super V>) - Static method in class net.adamcin.oakpal.api.Fun
Infers a method ref to a BiPredicate.
inSet(S) - Static method in class net.adamcin.oakpal.api.Fun
This method is used to support type inference around the Collection.contains(Object) method, whose argument is not otherwise typed with the element type parameter of the collection.
instance - Static variable in class net.adamcin.oakpal.api.Nothing
This is the singleton sentinel value.
isAllow() - Method in class net.adamcin.oakpal.api.Rule
Readability alias for Rule.isInclude() when the rule is used in the more abstract context of scope definition.
isDeny() - Method in class net.adamcin.oakpal.api.Rule
Readability alias for Rule.isExclude() when the rule is used in the more literal context of acceptable vs unacceptable values.
isExclude() - Method in class net.adamcin.oakpal.api.Rule
Readability alias for Rule.isDeny() when the rule is used in the more abstract context of scope definition.
isFailure() - Method in class net.adamcin.oakpal.api.Result
 
isInclude() - Method in class net.adamcin.oakpal.api.Rule
Readability alias for Rule.isAllow() when the rule is used in the more abstract context of scope definition.
isKeyIn(M) - Static method in class net.adamcin.oakpal.api.Fun
This method is used to support type inference around the Map.containsKey(Object) method, whose argument is not otherwise typed with the key type parameter of the Map.
isLessSevereThan(Severity) - Method in enum net.adamcin.oakpal.api.Severity
 
isNoop() - Method in enum net.adamcin.oakpal.api.PathAction
Returns true if this is the NOOP action type.
isSuccess() - Method in class net.adamcin.oakpal.api.Result
 
isUnknown() - Method in enum net.adamcin.oakpal.api.PathAction
Returns true if this is the PathAction.UNKNOWN fallback action type.
isValueIn(M) - Static method in class net.adamcin.oakpal.api.Fun
This method is used to support type inference around the Map.containsValue(Object) method, whose argument is not otherwise typed with the value type parameter of the Map.

J

JavaxJson - Class in net.adamcin.oakpal.api
Simple DSL for constructing javax.json objects for ProgressCheckFactory configs using only three-letter identifiers.
JavaxJson.Arr - Class in net.adamcin.oakpal.api
Constructs an array by iterating over a list of JavaxJson.Value instances.
JavaxJson.As<TYPE> - Interface in net.adamcin.oakpal.api
Defines a get method returns the constructed type parameter.
JavaxJson.Cursor - Interface in net.adamcin.oakpal.api
Type which allows a different fluent style for building keys, i.e.
JavaxJson.HasValue - Interface in net.adamcin.oakpal.api
Defines a method toValue which coalesces the underlying value to prevent over-wrapping by the JavaxJson.val(Object) method.
JavaxJson.Key - Class in net.adamcin.oakpal.api
Iterative key-value pair type for building JavaxJson.Obj instances.
JavaxJson.KeyCursor - Class in net.adamcin.oakpal.api
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 - Class in net.adamcin.oakpal.api
Constructs an object by iterating over a list of JavaxJson.Key instances.
JavaxJson.ObjCursor - Class in net.adamcin.oakpal.api
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 - Class in net.adamcin.oakpal.api
Discrete value wrapper.
JSON_VALUE_STRING - Static variable in class net.adamcin.oakpal.api.JavaxJson
This is needed to easily map untyped JsonString instances to String, since we don't use the JsonObject.getString(String) methods.
JsonArrayConvertible - Interface in net.adamcin.oakpal.api
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 - Interface in net.adamcin.oakpal.api
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).

K

keepFirstMerger() - Static method in class net.adamcin.oakpal.api.Fun
A merge function for Fun.entriesToMap(BinaryOperator) and Fun.entriesToMapOfType(Supplier, BinaryOperator) that keeps the first element defined for a key when merging duplicates.
keepLastMerger() - Static method in class net.adamcin.oakpal.api.Fun
A merge function for Fun.entriesToMap(BinaryOperator) and Fun.entriesToMapOfType(Supplier, BinaryOperator) that keeps the last element defined for a key when merging duplicates.
key(String, Object) - Static method in class net.adamcin.oakpal.api.JavaxJson
Creates a key-value pair for use with JavaxJson.obj(Key...).
key(String) - Static method in class net.adamcin.oakpal.api.JavaxJson
Begin a key-value pair without providing a value argument.
key(String) - Method in class net.adamcin.oakpal.api.JavaxJson.Key
 
key(String, Object) - Method in class net.adamcin.oakpal.api.JavaxJson.Key
 
key(String) - Method in class net.adamcin.oakpal.api.JavaxJson.Obj
Begin another JavaxJson.Key instance without providing an associated value.
key(String, Object) - Method in class net.adamcin.oakpal.api.JavaxJson.Obj
Append another JavaxJson.Key instance.
keys() - Static method in class net.adamcin.oakpal.api.Rule
 

L

lastMatch(List<Rule>, String, Function<List<Rule>, Rule>) - Static method in class net.adamcin.oakpal.api.Rules
Evaluate the provided list of rules against the String value using the provided selector function to select the default rule when none match.
lastMatch(List<Rule>, String) - Static method in class net.adamcin.oakpal.api.Rules
Evaluate the provided list of rules against the String value, using Rules.fuzzyDefaultInclude(List) to select the default rule when none match.
logAndRestream() - Static method in class net.adamcin.oakpal.api.Result
 
logAndRestream(String) - Static method in class net.adamcin.oakpal.api.Result
 

M

majorViolation(String, PackageId...) - Method in class net.adamcin.oakpal.api.SimpleProgressCheck
 
map(Function<? super V, W>) - Method in class net.adamcin.oakpal.api.Result
Map it.
mapArrayOfObjects(JsonArray, Function<JsonObject, R>) - Static method in class net.adamcin.oakpal.api.JavaxJson
Filters and maps the provided JsonArray into a List<JsonObject>, then applies the provided mapFunction to each result to return a typed list.
mapArrayOfObjects(JsonArray, Function<JsonObject, R>, boolean) - Static method in class net.adamcin.oakpal.api.JavaxJson
Filters and maps the provided JsonArray into a List<JsonObject>, then applies the provided mapFunction to each result to return a typed list.
mapArrayOfStrings(JsonArray) - Static method in class net.adamcin.oakpal.api.JavaxJson
Filters and maps the provided JsonArray into a List<String>.
mapArrayOfStrings(JsonArray, Function<String, R>) - Static method in class net.adamcin.oakpal.api.JavaxJson
Filters and maps the provided JsonArray into a List<String>, then applies the provided mapFunction to each result to return a typed list.
mapArrayOfStrings(JsonArray, Function<String, R>, boolean) - Static method in class net.adamcin.oakpal.api.JavaxJson
Filters and maps the provided JsonArray into a List<String>, then applies the provided mapFunction to each result to return a typed list.
mapEntry(BiFunction<? super K, ? super V, ? extends R>) - Static method in class net.adamcin.oakpal.api.Fun
Transform a BiFunction to a Function over Map.Entry stream elements of the same key and value type parameters.
mapKey(BiFunction<? super K, ? super V, ? extends L>) - Static method in class net.adamcin.oakpal.api.Fun
Transform a BiFunction to a Function over Map.Entry stream elements of the same key and value type parameters, that returns new Map.Entry elements that retain the input value but take the output of the BiFunction as the new key.
mapKey(Function<? super K, ? extends L>) - Static method in class net.adamcin.oakpal.api.Fun
Transform a Function over key types to a Function over Map.Entry stream elements whose key type matches the input type of the Function, that returns new Map.Entry elements that retain the input value but take the output of the Function as the new key.
mapObjectValues(JsonObject, BiFunction<String, JsonObject, R>, boolean) - Static method in class net.adamcin.oakpal.api.JavaxJson
Filters and maps the provided JsonObject into a Map<String, JsonObject>, then applies the provided mapBiFunction to each result pair to return a typed list.
mapValue(BiFunction<? super K, ? super V, ? extends W>) - Static method in class net.adamcin.oakpal.api.Fun
Transform a BiFunction to a Function over Map.Entry stream elements of the same key and value type parameters, that returns new Map.Entry elements that retain the input key but take the output of the BiFunction as the new value.
mapValue(Function<? super V, ? extends W>) - Static method in class net.adamcin.oakpal.api.Fun
Transform a Function over value types to a Function over Map.Entry stream elements whose value type matches the input type of the Function, that returns new Map.Entry elements that retain the input key but take the output of the Function as the new value.
matches(String) - Method in class net.adamcin.oakpal.api.Rule
Conventional usage of the rule's Pattern to match the entirety of the provided string value.
maxSeverity(Severity) - Method in enum net.adamcin.oakpal.api.Severity
 
meetsMinimumSeverity() - Method in enum net.adamcin.oakpal.api.Severity
 
minorViolation(String, PackageId...) - Method in class net.adamcin.oakpal.api.SimpleProgressCheck
 

N

net.adamcin.oakpal.api - package net.adamcin.oakpal.api
 
newInstance(JsonObject) - Method in interface net.adamcin.oakpal.api.ProgressCheckFactory
Returns a new check with the provided config.
nonDefaultValue(JsonValue, JsonValue) - Static method in class net.adamcin.oakpal.api.JavaxJson
Return true if the value is not equal to the provided default value.
nonEmptyValue(JsonValue) - Static method in class net.adamcin.oakpal.api.JavaxJson
To keep things simple and concise, the JSON CND format does not need to serialize null values, empty arrays, or empty objects.
Nothing - Class in net.adamcin.oakpal.api
A sentinel type for functional parameters representing Nothing, like Void.

O

obj(JavaxJson.Key...) - Static method in class net.adamcin.oakpal.api.JavaxJson
Create an object with the provided key-value pairs.
obj(JsonObject) - Static method in class net.adamcin.oakpal.api.JavaxJson
Create an object, and add all the keys from the provided json object to it.
obj(Map<?, ?>) - Static method in class net.adamcin.oakpal.api.JavaxJson
Create an object, and add all the keys from the provided map to it.
objectOrEmpty(JsonObject, String) - Static method in class net.adamcin.oakpal.api.JavaxJson
Retrieve a value as an object, or return the empty object if key is not present or if the value is the wrong type.
onEntry(BiConsumer<? super K, ? super V>) - Static method in class net.adamcin.oakpal.api.Fun
Transform a BiConsumer to a Consumer of Map.Entry stream elements with matching respective key and value type parameters.
onKey(Consumer<? super K>) - Static method in class net.adamcin.oakpal.api.Fun
Transform a Consumer of key types to a Consumer of Map.Entry stream elements with a matching key type parameter.
onValue(Consumer<? super V>) - Static method in class net.adamcin.oakpal.api.Fun
Transform a Consumer of value types to a Consumer of Map.Entry stream elements with a matching value type parameter.
opt(Object) - Method in class net.adamcin.oakpal.api.JavaxJson.Arr
 
opt(Object, Object) - Method in class net.adamcin.oakpal.api.JavaxJson.Arr
 
opt(Object) - Method in class net.adamcin.oakpal.api.JavaxJson.KeyCursor
 
opt(Object, Object) - Method in class net.adamcin.oakpal.api.JavaxJson.KeyCursor
 
opt(Object) - Method in class net.adamcin.oakpal.api.JavaxJson.ObjCursor
 
opt(Object, Object) - Method in class net.adamcin.oakpal.api.JavaxJson.ObjCursor
 
optArray(JsonObject, String) - Static method in class net.adamcin.oakpal.api.JavaxJson
Retrieve a value as an array if the specified key is present, or empty() if not.
optObject(JsonObject, String) - Static method in class net.adamcin.oakpal.api.JavaxJson
Retrieve a value as an object if the specified key is present, or empty() if not.
orElse(Supplier<Result<V>>) - Method in class net.adamcin.oakpal.api.Result
 

P

packages() - Method in interface net.adamcin.oakpal.api.ApiConstants.ViolationKeys
 
parseFromArray(JsonArray, Fun.ThrowingFunction<String, R>, BiConsumer<String, Exception>) - Static method in class net.adamcin.oakpal.api.JavaxJson
Parse string elements of an array into arbitrary objects, (like URLs).
PathAction - Enum in net.adamcin.oakpal.api
Enumeration of progress tracker path import action types.
pattern() - Method in interface net.adamcin.oakpal.api.Rule.JsonKeys
 
ProgressCheck - Interface in net.adamcin.oakpal.api
Primary point of customization for the OakPAL framework.
ProgressCheckFactory - Interface in net.adamcin.oakpal.api
A factory for creating ProgressChecks that accepts a config map.

R

readManifest(PackageId, Manifest) - Method in interface net.adamcin.oakpal.api.ProgressCheck
If the package provides a Manifest, it will be provided to the check using this method, prior to calling ProgressCheck.beforeExtract(PackageId, Session, PackageProperties, MetaInf, List).
ReportCollector - Class in net.adamcin.oakpal.api
Simple collector of violations for use by ProgressCheck implementations.
ReportCollector() - Constructor for class net.adamcin.oakpal.api.ReportCollector
 
reporting(Consumer<SimpleViolation.Builder>) - Method in class net.adamcin.oakpal.api.SimpleProgressCheck
Report a violation with a customizing consumer function.
reportViolation(Violation) - Method in class net.adamcin.oakpal.api.ReportCollector
 
reportViolation(Violation) - Method in class net.adamcin.oakpal.api.SimpleProgressCheck
 
reportViolation(Severity, String, PackageId...) - Method in class net.adamcin.oakpal.api.SimpleProgressCheck
 
Result<V> - Class in net.adamcin.oakpal.api
A type representing either a successful result value, or failure, with an error.
Result.Builder<V,A> - Class in net.adamcin.oakpal.api
Builds a result for a wrapped collector.
result0(Fun.ThrowingSupplier<? extends R>) - Static method in class net.adamcin.oakpal.api.Fun
Transform a Fun.ThrowingSupplier to a Supplier of Result whose success type parameter is the same as the type parameter of the Fun.ThrowingSupplier.
result1(Fun.ThrowingFunction<? super T, ? extends R>) - Static method in class net.adamcin.oakpal.api.Fun
Transform a Fun.ThrowingFunction to a Function over the same input type parameter, which returns a Result whose success type parameter is the same as the output type of the Fun.ThrowingFunction.
result2(Fun.ThrowingBiFunction<? super K, ? super V, ? extends R>) - Static method in class net.adamcin.oakpal.api.Fun
Transform a Fun.ThrowingBiFunction to a BiFunction over the same input type parameters, which returns a Result whose success type parameter is the same as the output type of the Fun.ThrowingBiFunction.
resultNothing1(Fun.ThrowingConsumer<? super T>) - Static method in class net.adamcin.oakpal.api.Fun
Transform a Fun.ThrowingConsumer to a Function over the same input type parameter, but which returns a Result of success type Nothing.
resultNothing2(Fun.ThrowingBiConsumer<? super K, ? super V>) - Static method in class net.adamcin.oakpal.api.Fun
Transform a Fun.ThrowingBiConsumer to a BiFunction over the same input type parameters, but which returns a Result of success type Nothing.
Rule - Class in net.adamcin.oakpal.api
Standard Rule tuple capturing a rule type (include/exclude or allow/deny) and a regex pattern.
Rule(RuleType, Pattern) - Constructor for class net.adamcin.oakpal.api.Rule
Create a new rule.
Rule.JsonKeys - Interface in net.adamcin.oakpal.api
 
Rules - Class in net.adamcin.oakpal.api
Factory methods and defaults for Rule.
RuleType - Enum in net.adamcin.oakpal.api
Type for a Rule.

S

ScanListener - Interface in net.adamcin.oakpal.api
Defines listener notifications for beginning and end of scan common to ProgressCheck and ErrorListener.
setResourceBundle(ResourceBundle) - Method in class net.adamcin.oakpal.api.SimpleProgressCheck
 
setResourceBundle(ResourceBundle) - Method in interface net.adamcin.oakpal.api.ViolationReporter
Called by the framework before a scan to provide a resource bundle for immediate localization of strings.
severeViolation(String, PackageId...) - Method in class net.adamcin.oakpal.api.SimpleProgressCheck
 
severity() - Method in interface net.adamcin.oakpal.api.ApiConstants.ViolationKeys
 
Severity - Enum in net.adamcin.oakpal.api
Levels of severity for violations detected during package scans.
shallowMergeObjects(JsonObject, JsonObject) - Static method in class net.adamcin.oakpal.api.JavaxJson
Merge an overlay json object's entries into a base json object, replacing values for duplicate keys.
SimpleProgressCheck - Class in net.adamcin.oakpal.api
Simple implementation of a ProgressCheck with convenient methods for reporting and collecting violations.
SimpleProgressCheck() - Constructor for class net.adamcin.oakpal.api.SimpleProgressCheck
 
SimpleProgressCheckFactoryCheck<FACTORY extends ProgressCheckFactory> - Class in net.adamcin.oakpal.api
Convenience type for simple progress checks that are identified by their factory.
SimpleProgressCheckFactoryCheck(Class<FACTORY>) - Constructor for class net.adamcin.oakpal.api.SimpleProgressCheckFactoryCheck
Need to keep a handle on the concrete class.
SimpleViolation - Class in net.adamcin.oakpal.api
Simple implementation of a Violation.
SimpleViolation(Severity, String, PackageId...) - Constructor for class net.adamcin.oakpal.api.SimpleViolation
Constructor.
SimpleViolation(Severity, String, List<PackageId>) - Constructor for class net.adamcin.oakpal.api.SimpleViolation
Constructor.
SimpleViolation.Builder - Class in net.adamcin.oakpal.api
 
startedScan() - Method in interface net.adamcin.oakpal.api.ScanListener
Called once at the beginning of the scan to notify for re-initialization of listener state.
startedScan() - Method in class net.adamcin.oakpal.api.SimpleProgressCheck
 
stream() - Method in class net.adamcin.oakpal.api.Result
 
streamIt(T) - Static method in class net.adamcin.oakpal.api.Fun
What's the most efficient way to stream a single nullable element? I don't know, but maybe I randomly got it right under the hood.
streamOpt(Optional<T>) - Static method in class net.adamcin.oakpal.api.Fun
Use this to transform a less useful Optional into an equivalent single-element stream.
success(V) - Static method in class net.adamcin.oakpal.api.Result
 

T

tee(Consumer<? super T>) - Static method in class net.adamcin.oakpal.api.Fun
Transform a consumer into a "tee" (like the Unix command, evoking the shape of the letter, 'T') function that passes the input argument to output after calling Consumer.accept(Object) with the input.
teeLogError() - Method in class net.adamcin.oakpal.api.Result
 
testEntry(BiPredicate<? super K, ? super V>) - Static method in class net.adamcin.oakpal.api.Fun
Transform a BiPredicate to a Predicate testing Map.Entry stream elements with matching respective key and value type parameters.
testKey(Predicate<? super K>) - Static method in class net.adamcin.oakpal.api.Fun
Transform a Predicate of key types to a Predicate testing Map.Entry stream elements with a matching key type parameter.
testOrDefault1(Fun.ThrowingPredicate<? super T>, boolean) - Static method in class net.adamcin.oakpal.api.Fun
Transform a Fun.ThrowingPredicate to a Predicate, providing a default boolean value to return if an exception is thrown.
testOrDefault2(Fun.ThrowingBiPredicate<? super K, ? super V>, boolean) - Static method in class net.adamcin.oakpal.api.Fun
Transform a Fun.ThrowingBiPredicate to a BiPredicate, providing a default boolean value to return if an exception is thrown.
testValue(Predicate<? super V>) - Static method in class net.adamcin.oakpal.api.Fun
Transform a Predicate of value types to a Predicate testing Map.Entry stream elements with a matching value type parameter.
throwCause(Class<E>) - Method in class net.adamcin.oakpal.api.Result
Feeling down because of too much functional wrapping? This method has you covered.
throwingMerger() - Static method in class net.adamcin.oakpal.api.Fun
A merge function for Fun.entriesToMap(BinaryOperator) and Fun.entriesToMapOfType(Supplier, BinaryOperator) that throws an IllegalStateException when merging duplicates to guarantee distinct pairs.
throwingVoidToNothing1(Fun.ThrowingConsumer<? super T>) - Static method in class net.adamcin.oakpal.api.Fun
Parallel method to Nothing.voidToNothing1(Consumer), for transforming a Fun.ThrowingConsumer to a Fun.ThrowingFunction that returns Nothing.
throwingVoidToNothing2(Fun.ThrowingBiConsumer<? super K, ? super V>) - Static method in class net.adamcin.oakpal.api.Fun
Parallel method to Nothing.voidToNothing2(BiConsumer), for transforming a Fun.ThrowingBiConsumer to a Fun.ThrowingBiFunction that returns Nothing.
toEntry(K, V) - Static method in class net.adamcin.oakpal.api.Fun
An alias for creating a AbstractMap.SimpleImmutableEntry for the provided key and value.
toJson() - Method in interface net.adamcin.oakpal.api.JsonArrayConvertible
 
toJson() - Method in interface net.adamcin.oakpal.api.JsonObjectConvertible
 
toJson() - Method in class net.adamcin.oakpal.api.Rule
Serializes the rule to a JsonObject.
toJson() - Method in interface net.adamcin.oakpal.api.Violation
Serializes the Violation to a JsonObject.
toOptional() - Method in class net.adamcin.oakpal.api.Result
 
toString() - Method in enum net.adamcin.oakpal.api.PathAction
 
toString() - Method in class net.adamcin.oakpal.api.Rule
 
toString() - Method in class net.adamcin.oakpal.api.SimpleViolation
 
toValue() - Method in class net.adamcin.oakpal.api.JavaxJson.Arr
 
toValue() - Method in interface net.adamcin.oakpal.api.JavaxJson.HasValue
 
toValue() - Method in class net.adamcin.oakpal.api.JavaxJson.Key
 
toValue() - Method in class net.adamcin.oakpal.api.JavaxJson.Obj
 
toValue() - Method in class net.adamcin.oakpal.api.JavaxJson.Value
 
toVoid1(Function<? super T, ?>) - Static method in class net.adamcin.oakpal.api.Fun
Infers a Function.apply(Object) signature as a Consumer.
toVoid2(BiFunction<? super K, ? super V, ?>) - Static method in class net.adamcin.oakpal.api.Fun
tryAccept(K, V) - Method in interface net.adamcin.oakpal.api.Fun.ThrowingBiConsumer
 
tryAccept(T) - Method in interface net.adamcin.oakpal.api.Fun.ThrowingConsumer
 
tryApply(K, V) - Method in interface net.adamcin.oakpal.api.Fun.ThrowingBiFunction
 
tryApply(T) - Method in interface net.adamcin.oakpal.api.Fun.ThrowingFunction
 
tryCollect(Collector<V, A, R>) - Static method in class net.adamcin.oakpal.api.Result
Create a collector that accumulates a stream of Results into a single Result containing either: 1.
tryGet() - Method in interface net.adamcin.oakpal.api.Fun.ThrowingSupplier
 
tryOrDefault0(Fun.ThrowingSupplier<R>, R) - Static method in class net.adamcin.oakpal.api.Fun
Transform a Fun.ThrowingSupplier to a Supplier, providing a default value to return if an exception is thrown.
tryOrDefault1(Fun.ThrowingFunction<? super T, R>, R) - Static method in class net.adamcin.oakpal.api.Fun
Transform a Fun.ThrowingFunction to a Function, providing a default value to return if an exception is thrown.
tryOrDefault2(Fun.ThrowingBiFunction<? super K, ? super V, R>, R) - Static method in class net.adamcin.oakpal.api.Fun
Transform a Fun.ThrowingBiFunction to a BiFunction, providing a default value to return if an exception is thrown.
tryOrOptional0(Fun.ThrowingSupplier<R>) - Static method in class net.adamcin.oakpal.api.Fun
Transform a Fun.ThrowingSupplier to a Supplier of the same type, wrapped in an Optional.
tryOrOptional1(Fun.ThrowingFunction<? super T, R>) - Static method in class net.adamcin.oakpal.api.Fun
Transform a Fun.ThrowingFunction to a Function of the same input type, with the output type wrapped in an Optional.
tryOrOptional2(Fun.ThrowingBiFunction<? super K, ? super V, R>) - Static method in class net.adamcin.oakpal.api.Fun
Transform a Fun.ThrowingBiFunction to a BiFunction of the same input types, with the output type wrapped in an Optional.
tryOrVoid1(Fun.ThrowingConsumer<? super T>) - Static method in class net.adamcin.oakpal.api.Fun
Transform a Fun.ThrowingConsumer to a Consumer of the same input type, that simply suppresses any exceptions if thrown.
tryOrVoid2(Fun.ThrowingBiConsumer<? super K, ? super V>) - Static method in class net.adamcin.oakpal.api.Fun
Transform a Fun.ThrowingBiConsumer to a BiConsumer of the same input types, that simply suppresses any exceptions if thrown.
tryTest(K, V) - Method in interface net.adamcin.oakpal.api.Fun.ThrowingBiPredicate
 
tryTest(T) - Method in interface net.adamcin.oakpal.api.Fun.ThrowingPredicate
 
type() - Method in interface net.adamcin.oakpal.api.Rule.JsonKeys
 

U

uncheck0(Fun.ThrowingSupplier<? extends R>) - Static method in class net.adamcin.oakpal.api.Fun
Transform a Fun.ThrowingSupplier to an unchecked Supplier of the same supplied type parameter.
uncheck1(Fun.ThrowingFunction<? super T, ? extends R>) - Static method in class net.adamcin.oakpal.api.Fun
Transform a Fun.ThrowingFunction to an unchecked Function of the same input and output type parameters.
uncheck2(Fun.ThrowingBiFunction<? super K, ? super V, ? extends R>) - Static method in class net.adamcin.oakpal.api.Fun
Transform a Fun.ThrowingBiFunction to an unchecked BiFunction of the same input and output type parameters.
uncheckTest1(Fun.ThrowingPredicate<? super T>) - Static method in class net.adamcin.oakpal.api.Fun
Transform a Fun.ThrowingPredicate to a Predicate of the same input type parameter.
uncheckTest2(Fun.ThrowingBiPredicate<? super K, ? super V>) - Static method in class net.adamcin.oakpal.api.Fun
Transform a Fun.ThrowingBiPredicate to a BiPredicate of the same input type parameter.
uncheckVoid1(Fun.ThrowingConsumer<? super T>) - Static method in class net.adamcin.oakpal.api.Fun
Transform a Fun.ThrowingConsumer to a Consumer of the same input type parameter.
uncheckVoid2(Fun.ThrowingBiConsumer<? super K, ? super V>) - Static method in class net.adamcin.oakpal.api.Fun
Transform a Fun.ThrowingBiConsumer to a BiConsumer of the same input type parameter.
unwrap(JsonValue) - Static method in class net.adamcin.oakpal.api.JavaxJson
This method performs the reverse of JavaxJson.wrap(Object).
unwrapArray(JsonArray) - Static method in class net.adamcin.oakpal.api.JavaxJson
Supports JavaxJson.unwrap(JsonValue) for typed unwrapping of JsonArray to List<Object>.
unwrapObject(JsonObject) - Static method in class net.adamcin.oakpal.api.JavaxJson
Supports JavaxJson.unwrap(JsonValue) for typed unwrapping of JsonObject to Map<String, Object>.

V

val(Object) - Method in class net.adamcin.oakpal.api.JavaxJson.Arr
 
val(Object) - Method in class net.adamcin.oakpal.api.JavaxJson.KeyCursor
 
val(Object) - Method in class net.adamcin.oakpal.api.JavaxJson.ObjCursor
 
val(Object) - Static method in class net.adamcin.oakpal.api.JavaxJson
Ensures that an object reference is wrapped appropriately for use in the DSL.
val(Object) - Method in class net.adamcin.oakpal.api.JavaxJson.Value
Conveniently allows one to start an array without the use of JavaxJson.arr(Object...).
valueOf(String) - Static method in enum net.adamcin.oakpal.api.PathAction
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum net.adamcin.oakpal.api.RuleType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum net.adamcin.oakpal.api.Severity
Returns the enum constant of this type with the specified name.
values() - Static method in enum net.adamcin.oakpal.api.PathAction
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.adamcin.oakpal.api.RuleType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.adamcin.oakpal.api.Severity
Returns an array containing the constants of this enum type, in the order they are declared.
Violation - Interface in net.adamcin.oakpal.api
Report type for validations.
violationKeys() - Static method in class net.adamcin.oakpal.api.ApiConstants
 
ViolationReporter - Interface in net.adamcin.oakpal.api
Base interface for violation reporters.
voidToNothing1(Consumer<? super T>) - Static method in class net.adamcin.oakpal.api.Nothing
 
voidToNothing2(BiConsumer<? super T, ? super U>) - Static method in class net.adamcin.oakpal.api.Nothing
 

W

withArgument(Object...) - Method in class net.adamcin.oakpal.api.SimpleViolation.Builder
Add one or more arguments.
withArguments(List<Object>) - Method in class net.adamcin.oakpal.api.SimpleViolation.Builder
Set arguments.
withDescription(String) - Method in class net.adamcin.oakpal.api.SimpleViolation.Builder
Set description.
withPackage(PackageId...) - Method in class net.adamcin.oakpal.api.SimpleViolation.Builder
Add one or more packageIds.
withPackages(List<PackageId>) - Method in class net.adamcin.oakpal.api.SimpleViolation.Builder
Set package ids.
withSeverity(Severity) - Method in class net.adamcin.oakpal.api.SimpleViolation.Builder
Set severity.
wrap(Object) - Static method in class net.adamcin.oakpal.api.JavaxJson
Ensures that a Java typed object is wrapped with the appropriate JsonValue type.

Z

zipKeysWithValueFunc(Function<? super K, ? extends V>) - Static method in class net.adamcin.oakpal.api.Fun
Zips stream elements into Map.Entry elements as keys, with values mapped from the provided function, which can, for example, be a Map.get(Object) method reference to perform a lookup.
zipValuesWithKeyFunc(Function<? super V, ? extends K>) - Static method in class net.adamcin.oakpal.api.Fun
Zips stream elements into Map.Entry elements as values, with keys mapped from the provided function, which can, for example, be a Map.get(Object) method reference to perform a lookup.
A B C D E F G H I J K L M N O P R S T U V W Z 
Skip navigation links

Copyright © 2017–2020. All rights reserved.