org.apache.maven.shared.filtering.DefaultMavenReaderFilter Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of maven-filtering Show documentation

A component to assist in filtering of resource files with properties from a Maven project.

There is a newer version: 3.1.2-patch1

package org.apache.maven.shared.filtering;

/*
 * 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.
 */

import java.io.Reader;
import java.util.Collections;
import java.util.List;

import javax.annotation.Nonnull;

import org.apache.maven.execution.MavenSession;
import org.apache.maven.project.MavenProject;
import org.apache.maven.shared.utils.io.FileUtils.FilterWrapper;
import org.codehaus.plexus.component.annotations.Component;

/**
 * @author Kristian Rosenvold
 */
@Component( role = org.apache.maven.shared.filtering.MavenReaderFilter.class, hint = "default" )
public class DefaultMavenReaderFilter
    extends BaseFilter
    implements MavenReaderFilter
{
    /** {@inheritDoc} */
    @Nonnull
    public Reader filter( @Nonnull Reader from, boolean filtering, MavenProject mavenProject, List filters,
                          boolean escapedBackslashesInFilePath, MavenSession mavenSession )
                              throws MavenFilteringException
    {
        MavenResourcesExecution mre = new MavenResourcesExecution();
        mre.setMavenProject( mavenProject );
        mre.setFileFilters( filters );
        mre.setEscapeWindowsPaths( escapedBackslashesInFilePath );
        mre.setMavenSession( mavenSession );
        mre.setInjectProjectBuildFilters( true );

        List filterWrappers = getDefaultFilterWrappers( mre );
        return filter( from, filtering, filterWrappers );
    }

    /** {@inheritDoc} */
    @Nonnull
    public Reader filter( @Nonnull MavenReaderFilterRequest mavenFileFilterRequest )
        throws MavenFilteringException
    {
        List filterWrappers = getDefaultFilterWrappers( mavenFileFilterRequest );
        return filter( mavenFileFilterRequest.getFrom(), mavenFileFilterRequest.isFiltering(), filterWrappers );
    }

    /** {@inheritDoc} */
    @Nonnull
    public Reader filter( @Nonnull Reader from, boolean filtering, @Nonnull List filterWrappers )
    {
        return filterWrap( from, filtering ? filterWrappers : Collections.emptyList() );
    }

    @Nonnull
    private static Reader filterWrap( @Nonnull Reader from, @Nonnull Iterable wrappers )
    {
        Reader reader = from;
        for ( FilterWrapper wrapper : wrappers )
        {
            reader = wrapper.getReader( reader );
        }
        return reader;
    }

}