Coverage Report - org.apache.any23.mime.purifier.Purifier
 
Classes in this File Line Coverage Branch Coverage Complexity
Purifier
N/A
N/A
1
 
 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
 25  
  * a {@link org.apache.any23.mime.TikaMIMETypeDetector} could
 26  
  * call in order to clean the input before performing the <i>MIME type</i>
 27  
  * detection.
 28  
  * 
 29  
  * @author Davide Palmisano ( dpalmisano@gmail.com )
 30  
  */
 31  
 public interface Purifier {
 32  
 
 33  
     /**
 34  
      * Performs the purification of the provided resettable {@link java.io.InputStream}.
 35  
      * 
 36  
      * @param inputStream a resettable {@link java.io.InputStream} to be cleaned.
 37  
      */
 38  
     void purify(InputStream inputStream) throws IOException;
 39  
 
 40  
 }