com.mastfrog.giulius.mongodb.async.DynamicCodecs Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of giulius-mongodb-async Show documentation

There is a newer version: 2.9.7

Show newest version

/*
 * The MIT License
 *
 * Copyright 2015 Tim Boudreau.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.mastfrog.giulius.mongodb.async;

import com.google.inject.ImplementedBy;
import com.mastfrog.giulius.mongodb.async.GiuliusMongoAsyncModule.DefaultFallbackCodecs;
import org.bson.codecs.Codec;
import org.bson.codecs.configuration.CodecConfigurationException;

/**
 * Interface that allows for codecs using technologies like Jackson to be
 * generated dynamically.  It is more efficient to write your own codec, but
 * this is useful for rapid prototyping.
 *
 * @author Tim Boudreau
 */
@ImplementedBy(DefaultFallbackCodecs.class)
public interface DynamicCodecs {

    /**
     * Create a codec for this type, or rethrow the previous exception.
     * 
     * @param  The type
     * @param type The type
     * @param ex The exception that was thrown by the default registry
     * @return A codec
     */
     Codec createCodec(Class type, CodecConfigurationException ex);
    
}