com.zackehh.jackson.scope.SafeExecution Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jive Show documentation

Java utility library for working with Jackson JSON w/ Stream support

The newest version!

package com.zackehh.jackson.scope;

import com.fasterxml.jackson.databind.ObjectMapper;

import java.io.IOException;

/**
 * Interface to execute a block in a scope which catches an IOException.
 *
 * The intent is that this interface can be used to execute ObjectMapper
 * based operations without having to implement your own catching.
 *
 * @param  the result typing.
 */
public interface SafeExecution {

    /**
     * Executes the custom logic on a provided ObjectMapper and
     * returns the defined custom type as a result.
     *
     * @param mapper an ObjectMapper instance to use in scope.
     * @return an instance of the defined custom type.
     * @throws IOException if an error occurs in the Jackson operation.
     */
    T apply(ObjectMapper mapper) throws Exception;
}