BoilerpipeInput.java

/**
 * Copyright (C) 2013 Christian Kohlschütter (ckkohl79@gmail.com)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package de.l3s.boilerpipe;

import de.l3s.boilerpipe.document.TextDocument;

/**
 * A source that returns {@link de.l3s.boilerpipe.document.TextDocument}s.
 * 
 * @author Christian Kohlschütter
 */
public interface BoilerpipeInput {
    /**
     * Returns (somehow) a {@link de.l3s.boilerpipe.document.TextDocument}.
     * 
     * @return  A {@link de.l3s.boilerpipe.document.TextDocument}.
     * @throws BoilerpipeProcessingException
     */
    TextDocument getTextDocument() throws BoilerpipeProcessingException;
}