de.mrapp.parser.feed.common.source.Source Maven / Gradle / Ivy

Go to download
/*
 * JavaFeedParserCommon Copyright 2013-2014 Michael Rapp
 *
 * This program 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 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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, see . 
 */
package de.mrapp.parser.feed.common.source;

import org.jdom2.Document;

import de.mrapp.parser.feed.common.builder.InvalidSourceException;

/**
 * Defines the interface, a class, which should provide a source, which allows
 * to parse the XML structure of a feed, must implement.
 * 
 * @author Michael Rapp
 * 
 * @since 1.0.0
 */
public interface Source {

	/**
	 * Returns a {@link Document}, which represents the XML structure of the
	 * feed, which is provided by the source.
	 * 
	 * @return The document, which represents the XML structure of the feed,
	 *         which is provided by the source, as an instance of the class
	 *         {@link Document}
	 * @throws InvalidSourceException
	 *             The exception, which is thrown, if any problem occurs, while
	 *             accessing the XML structure of the feed
	 */
	Document getDocument() throws InvalidSourceException;

}