SimpleFilterLocator.java

/*
 * 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.sling.ide.impl.resource.filer;

import java.io.BufferedReader;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.util.ArrayList;
import java.util.List;

import org.apache.sling.ide.filter.Filter;
import org.apache.sling.ide.filter.FilterLocator;

/**
 * The <tt>SimpleFilterLocator</tt> looks for a file named {@value #FILTERS_FILE_NAME} in the parent folder of the
 * specified <tt>syncDirectory</tt>.
 * 
 * <p>
 * Lines starting with '#' are ignored.
 * </p>
 * 
 * @see SimpleFilter
 * 
 */
public class SimpleFilterLocator implements FilterLocator {

    private static final String FILTERS_FILE_NAME = "filters.txt";

    @Override
    public File findFilterLocation(File syncDirectory) {
        String parent = syncDirectory.getParent();

        return new File(parent, FILTERS_FILE_NAME);
    }

    @Override
    public Filter loadFilter(InputStream filterFileContents) throws IOException {

        List<String> filters = new ArrayList<>();
        if (filterFileContents != null) {
            BufferedReader reader = new BufferedReader(new InputStreamReader(filterFileContents));
            String line;
            while ((line = reader.readLine()) != null) {
                if (line.charAt(0) == '#')
                    continue;
                filters.add(line);
            }
        }

        return new SimpleFilter(filters);
    }
}