AbstractTemplateParser.java

/**
 * Copyright (c) 2013-2016, The SeedStack authors <http://seedstack.org>
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
package org.seedstack.io.spi;

import org.seedstack.io.Parser;

import java.io.InputStream;
import java.util.List;

/**
 * Class to extends in order to have.
 *
 * @param <TEMPLATE>      template used to parse.
 * @param <PARSED_OBJECT> object parsed.
 */
public abstract class AbstractTemplateParser<TEMPLATE, PARSED_OBJECT> implements Parser<PARSED_OBJECT> {

    /**
     * Parser template
     */
    protected TEMPLATE template;

    /**
     * @param template template to set
     */
    public void setTemplate(TEMPLATE template) {
        this.template = template;
    }

    /**
     * Parse an InputStream as "clazz" object.
     *
     * @param inputStream input stream
     * @param clazz       expected object
     * @return list of parsed object
     */
    public abstract List<PARSED_OBJECT> parse(InputStream inputStream, Class<PARSED_OBJECT> clazz);
}