com.greenpepper.repository.DocumentBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of greenpepper-core Show documentation

The newest version!

/*
 * Copyright (c) 2006 Pyxis Technologies inc.
 *
 * This is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA,
 * or see the FSF site: http://www.fsf.org.
 */

package com.greenpepper.repository;

import com.greenpepper.dialect.SpecificationDialect;
import com.greenpepper.document.Document;

import java.io.IOException;
import java.io.InputStream;
import java.io.Reader;

/**
 * DocumentBuilder interface.
 *
 * @author oaouattara
 * @version $Id: $Id
 */
public interface DocumentBuilder
{
    /**
     * build.
     *
     * @param inputStream a {@link Reader} object.
     * @return a {@link com.greenpepper.document.Document} object.
     * @throws java.io.IOException if any.
     */
    Document build(InputStream inputStream) throws IOException;

    /**
     * Sets the {@link SpecificationDialect} for this document builder.
     * @param dialect the dialect to use
     * @return this DocumentBuilder for chaining calls.
     */
    DocumentBuilder withDialect(SpecificationDialect dialect);
}