Coverage Report - org.apache.commons.flatfile.util.FilterFactory
 
Classes in this File Line Coverage Branch Coverage Complexity
FilterFactory
0%
0/2
0%
0/2
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  
 package org.apache.commons.flatfile.util;
 18  
 
 19  
 import java.io.BufferedInputStream;
 20  
 import java.io.InputStream;
 21  
 import java.io.Serializable;
 22  
 
 23  
 /**
 24  
  * Filter factory interface designed for use with {@link InputFilteringDynamicField}.
 25  
  * @version $Revision: 758023 $ $Date: 2009-03-24 16:09:19 -0500 (Tue, 24 Mar 2009) $
 26  
  */
 27  0
 public abstract class FilterFactory implements Serializable {
 28  
     /** Serialization version */
 29  
     private static final long serialVersionUID = -172092815628700041L;
 30  
 
 31  
     /**
 32  
      * Get an InputStream that filters the specified {@link InputStream}
 33  
      * @param is the {@link InputStream} to filter
 34  
      * @return an {@link InputStream}
 35  
      */
 36  
     public final InputStream getFilter(InputStream is) {
 37  0
         return iGetFilter(is.markSupported() ? is : new BufferedInputStream(is));
 38  
     }
 39  
 
 40  
     /**
 41  
      * Template method to be implemented by subclasses.
 42  
      * @param markIsSupported guaranteed to support mark()/reset().
 43  
      * @return an {@link InputStream}
 44  
      */
 45  
     protected abstract InputStream iGetFilter(InputStream markIsSupported);
 46  
 }