org.fugerit.java.doc.base.parser.DocParser Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of fj-doc-base Show documentation

There is a newer version: 8.11.9

package org.fugerit.java.doc.base.parser;

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

import org.fugerit.java.doc.base.config.DocException;
import org.fugerit.java.doc.base.facade.DocFacadeSource;
import org.fugerit.java.doc.base.model.DocBase;

/**
 * Class implementing the parsing and validation of doc source
 * 
 * @author fugerit
 *
 */
public interface DocParser {
	
	/**
	 * Returns the source type handled by this parser
	 * 
	 * @return	the int representation  of the source type handled by this parser
	 * {@link DocFacadeSource}
	 */
	int getSourceType();
	
	/**
	 * Parse a source
	 * 
	 * @param is	the source stream
	 * @return		the parsed document
	 * @throws DocException		in case of problems
	 */
	DocBase parse( InputStream is ) throws DocException;
	
	/**
	 * Parse a source
	 * 
	 * @param reader	the source reader
	 * @return		the parsed document
	 * @throws DocException		in case of problems
	 */
	DocBase parse( Reader reader ) throws DocException;
	
	/**
	 * Validate a source
	 * 
	 * @param reader	the source reader
	 * @return		the result of the validation
	 * @throws DocException		in case of problems
	 */
	DocValidationResult validateResult( Reader reader ) throws DocException;
	
	/**
	 * Validate a source
	 * 
	 * @param reader	the source reader
	 * @return		the result of the validation (0 in case of success)
	 * @throws DocException		in case of problems
	 */
	int validate( Reader reader ) throws DocException;
	
	/**
	 * Validate a source, it tries to find the xsd version and validate against the specific version
	 * 
	 * @param reader	the source reader
	 * @return		the result of the validation
	 * @throws DocException		in case of problems
	 */
	DocValidationResult validateVersionResult( Reader reader ) throws DocException;
	
	/**
	 * Validate a source, it tries to find the xsd version and validate against the specific version
	 * 
	 * @param reader	the source reader
	 * @return		the result of the validation as an int (0 in case of success)
	 * @throws DocException		in case of problems
	 */
	int validateVersion( Reader reader ) throws DocException;
	
}