Module org.microbean.loader.jackson

Package org.microbean.loader.jackson

Class InputStreamJacksonProvider

java.lang.Object

org.microbean.loader.spi.AbstractProvider

org.microbean.loader.spi.AbstractTreeBasedProvider<TreeNode>

org.microbean.loader.jackson.JacksonProvider

org.microbean.loader.jackson.InputStreamJacksonProvider

All Implemented Interfaces:

Provider

Direct Known Subclasses:

JsonProvider, PropertiesProvider, TomlProvider, YamlProvider

public class InputStreamJacksonProvider
extends JacksonProvider

A JacksonProvider built around an InputStream-providing bifunction and an ObjectCodec-providing bifunction.

Author:

Laird Nelson

Constructor Summary

Constructors

Constructor	Description
InputStreamJacksonProvider(Type lowerBound, BiFunction<? super Loader<?>,? super Path<? extends Type>,? extends ObjectCodec> objectCodecFunction, BiFunction<? super Loader<?>,? super Path<? extends Type>,? extends InputStream> inputStreamFunction, Consumer<? super InputStream> inputStreamReadConsumer)	Creates a new InputStreamJacksonProvider.
InputStreamJacksonProvider(Type lowerBound, Supplier<? extends ObjectMapper> mapperSupplier, String resourceName)	Creates a new InputStreamJacksonProvider.

Method Summary

Modifier and Type	Method	Description
protected static final void	closeInputStream(InputStream is)	Calls InputStream.close() on the supplied InputStream if it is non-null.
protected static final InputStream	inputStream(ClassLoader cl, String resourceName)	Returns an open InputStream loaded using the supplied ClassLoader and a name of a classpath resource.
protected final ObjectCodec	objectCodec(Loader<?> requestingLoader, Path<? extends Type> absolutePath)	Invokes the BiFunction.apply(Object, Object) method of the objectCodecFunction supplied at construction time and returns the result.
protected TreeNode	rootNode(Loader<?> requestingLoader, Path<? extends Type> absolutePath)	Returns the root node of the tree that is suitable for the supplied Loader and Path, or null if no tree is suitable.

Methods inherited from class org.microbean.loader.jackson.JacksonProvider

absent, get, get, list, map, names, nil, qualifiers, reader, size

Methods inherited from class org.microbean.loader.spi.AbstractTreeBasedProvider

container, find, path, path, qualifiers

Methods inherited from class org.microbean.loader.spi.AbstractProvider

get, lowerBound

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

InputStreamJacksonProvider

public InputStreamJacksonProvider(Type lowerBound,
 Supplier<? extends ObjectMapper> mapperSupplier,
 String resourceName)

Creates a new InputStreamJacksonProvider.

Parameters:

lowerBound - the lower type bound of this InputStreamJacksonProvider implementation; may be null

mapperSupplier - a Supplier, deterministic or not, of ObjectMapper instances; ordinarily callers should supply a Supplier that caches; may be null

resourceName - a resource name that is treated first as a classpath resource and finally as the name of a file relative to the directory identified by the user.dir system property

See Also:

• InputStreamJacksonProvider(Type, BiFunction, BiFunction, Consumer)
• inputStream(ClassLoader, String)

InputStreamJacksonProvider

public InputStreamJacksonProvider(Type lowerBound,
 BiFunction<? super Loader<?>,? super Path<? extends Type>,? extends ObjectCodec> objectCodecFunction,
 BiFunction<? super Loader<?>,? super Path<? extends Type>,? extends InputStream> inputStreamFunction,
 Consumer<? super InputStream> inputStreamReadConsumer)

Creates a new InputStreamJacksonProvider.

Parameters:

lowerBound - the lower type bound of this InputStreamJacksonProvider implementation; may be null

objectCodecFunction - a BiFunction that returns an ObjectCodec when supplied with a Loader and a Path; may be null

inputStreamFunction - a BiFunction that returns an open InputStream when supplied with a Loader and a Path; may be null

inputStreamReadConsumer - a Consumer that is called with an InputStream after the InputStream has been fully read; may be null; normally should close the InputStream

Method Details

objectCodec

protected final ObjectCodec objectCodec(Loader<?> requestingLoader,
 Path<? extends Type> absolutePath)

Invokes the BiFunction.apply(Object, Object) method of the objectCodecFunction supplied at construction time and returns the result.

Specified by:

objectCodec in class JacksonProvider

Parameters:

requestingLoader - the Loader requesting a value; must not be null

absolutePath - the absolute Path the requestingLoader is currently requesting; must not be null

Returns:

an ObjectCodec suitable for the supplied arguments, or null if this InputStreamJacksonProvider should not handle the current request

Idempotency:

This method is idempotent and deterministic if the objectCodecFunction supplied at construction time is.

Nullability:

This method may return null.

Thread Safety:

This method is safe for concurrent use by multiple threads, but the objectCodecFunction supplied at construction time may not be.

rootNode

protected TreeNode rootNode(Loader<?> requestingLoader,
 Path<? extends Type> absolutePath)

Description copied from class: AbstractTreeBasedProvider

Returns the root node of the tree that is suitable for the supplied Loader and Path, or null if no tree is suitable.

Specified by:

rootNode in class AbstractTreeBasedProvider<TreeNode>

Parameters:

requestingLoader - the Loader currently executing a request; must not be null

absolutePath - the path being requested; must not be null and must be absolute

Returns:

the root node, or null

inputStream

@Convenience
protected static final InputStream inputStream(ClassLoader cl,
 String resourceName)

Returns an open InputStream loaded using the supplied ClassLoader and a name of a classpath resource.

This method never returns null.

Parameters:

cl - the ClassLoader that will actually cause the InputStream to be created and opened; may be null in which case the system classloader will be used instead

resourceName - the name of the classpath resource for which an InputStream will be created and opened; must not be null

Returns:

a non-null, open InputStream

Throws:

NullPointerException - if resourceName is null

Idempotency:

This method is idempotent and deterministic.

Nullability:

This method never returns null.

Thread Safety:

This method is safe for concurrent use by multiple threads.

closeInputStream

@Convenience
protected static final void closeInputStream(InputStream is)

Calls InputStream.close() on the supplied InputStream if it is non-null.

Parameters:

is - the InputStream; may be null in which case no action will be taken

Throws:

UncheckedIOException - if an IOException is thrown by the InputStream.close() method