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 import org.apache.commons.lang3.Validate;
24
25 /**
26 * Filter factory designed for use with {@link InputFilteringDynamicField}.
27 * @version $Revision: 1301244 $ $Date: 2012-03-15 17:16:23 -0500 (Thu, 15 Mar 2012) $
28 */
29 public abstract class FilterFactory implements Serializable {
30 /** Serialization version */
31 private static final long serialVersionUID = -172092815628700041L;
32
33 /**
34 * Get an InputStream that filters the specified {@link InputStream}
35 * @param is the {@link InputStream} to filter
36 * @return an {@link InputStream}
37 */
38 public final InputStream getFilter(final InputStream is) {
39 return iGetFilter(Validate.notNull(is).markSupported() ? is
40 : new BufferedInputStream(is));
41 }
42
43 /**
44 * Template method to be implemented by subclasses.
45 * @param markIsSupported guaranteed to support mark()/reset().
46 * @return an {@link InputStream}
47 */
48 protected abstract InputStream iGetFilter(InputStream markIsSupported);
49 }