com.nytimes.android.external.store3.middleware.GsonParserFactory Maven / Gradle / Ivy

Go to download
package com.nytimes.android.external.store3.middleware;


import com.google.gson.Gson;
import com.nytimes.android.external.store3.base.Parser;

import java.io.Reader;
import java.lang.reflect.Type;

import javax.annotation.Nonnull;

import okio.BufferedSource;

/**
 * Factory which returns various Gson {@link Parser} implementations.
 */
public final class GsonParserFactory {
    private GsonParserFactory() {
    }

    /**
     * Returns a new Parser which parses from {@link Reader} to the specified type, using
     * a new default configured {@link Gson} instance.
     */
    @Nonnull
    public static  Parser createReaderParser(@Nonnull Type type) {
        return createReaderParser(new Gson(), type);
    }

    /**
     * Returns a new Parser which parses from {@link Reader} to the specified type, using
     * the provided {@link Gson} instance.
     */
    @Nonnull
    public static  Parser createReaderParser(@Nonnull Gson gson, @Nonnull Type type) {
        return new GsonReaderParser<>(gson, type);
    }

    /**
     * Returns a new Parser which parses from {@link Reader} to the specified type, using
     * a new default configured {@link Gson} instance.
     */
    @Nonnull
    public static  Parser createSourceParser(@Nonnull Type type) {
        return createSourceParser(new Gson(), type);
    }

    /**
     * Returns a new Parser which parses from {@link BufferedSource} to the specified type, using
     * the provided {@link Gson} instance.
     */
    @Nonnull
    public static  Parser createSourceParser(@Nonnull Gson gson, @Nonnull Type type) {
        return new GsonSourceParser<>(gson, type);
    }

    /**
     * Returns a new Parser which parses from a String to the specified type, using
     * a new default {@link Gson} instance.
     */
    @Nonnull
    public static  Parser createStringParser(@Nonnull Class type) {
        return createStringParser(new Gson(), type);
    }

    /**
     * Returns a new Parser which parses from a String to the specified type, using
     * the provided {@link Gson} instance.
     */
    @Nonnull
    public static  Parser createStringParser(@Nonnull Gson gson, @Nonnull Type type) {
        return new GsonStringParser<>(gson, type);
    }

}