1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one *
3 * or more contributor license agreements. See the NOTICE file *
4 * distributed with this work for additional information *
5 * regarding copyright ownership. The ASF licenses this file *
6 * to you under the Apache License, Version 2.0 (the *
7 * "License"); you may not use this file except in compliance *
8 * with the License. You may obtain a copy of the License at *
9 * *
10 * http://www.apache.org/licenses/LICENSE-2.0 *
11 * *
12 * Unless required by applicable law or agreed to in writing, *
13 * software distributed under the License is distributed on an *
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *
15 * KIND, either express or implied. See the License for the *
16 * specific language governing permissions and limitations *
17 * under the License. *
18 */
19 package org.apache.rat.document;
20
21 import org.apache.rat.api.Document;
22
23 /**
24 * Analyses Documents.
25 */
26 @FunctionalInterface
27 public interface DocumentAnalyser {
28 /**
29 * Analyse the specified document.
30 * @param document the document to analyze
31 * @throws RatDocumentAnalysisException on error.
32 */
33 void analyse(Document document) throws RatDocumentAnalysisException;
34 }