/*

  * Licensed to the Apache Software Foundation (ASF) under one or more

  * contributor license agreements.  See the NOTICE file distributed with

  * this work for additional information regarding copyright ownership.

  * The ASF licenses this file to You 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 org.apache.commons.flatfile.util;

 import java.io.BufferedInputStream;

 import java.io.InputStream;

 import java.io.Serializable;

 /**

  * Filter factory interface designed for use with {@link InputFilteringDynamicField}.

  * @version $Revision: 758023 $ $Date: 2009-03-24 16:09:19 -0500 (Tue, 24 Mar 2009) $

  */

 public abstract class FilterFactory implements Serializable {

     /** Serialization version */

     private static final long serialVersionUID = -172092815628700041L;

     /**

      * Get an InputStream that filters the specified {@link InputStream}

      * @param is the {@link InputStream} to filter

      * @return an {@link InputStream}

      */

     public final InputStream getFilter(InputStream is) {

         return iGetFilter(is.markSupported() ? is : new BufferedInputStream(is));

     }

     /**

      * Template method to be implemented by subclasses.

      * @param markIsSupported guaranteed to support mark()/reset().

      * @return an {@link InputStream}

      */

     protected abstract InputStream iGetFilter(InputStream markIsSupported);

 }