View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *  http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package org.apache.any23.mime.purifier;
19  
20  import java.io.IOException;
21  import java.io.InputStream;
22  
23  /**
24   * This interface defines a minimum set of methods that a TikaMIMETypeDetector could call in order to clean the input
25   * before performing the <i>MIME type</i> detection.
26   * 
27   * @author Davide Palmisano ( dpalmisano@gmail.com )
28   */
29  public interface Purifier {
30  
31      /**
32       * Performs the purification of the provided resettable {@link java.io.InputStream}.
33       * 
34       * @param inputStream
35       *            a resettable {@link java.io.InputStream} to be cleaned.
36       * 
37       * @throws IOException
38       *             if there is an error accessing the {@link java.io.InputStream}
39       */
40      void purify(InputStream inputStream) throws IOException;
41  
42  }