org.codehaus.plexus.languages.java.jpms.ResolvePathsRequest Maven / Gradle / Ivy

Go to download
package org.codehaus.plexus.languages.java.jpms;

/*
 * 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.File;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;

/**
 * Contains all information required to analyze the project
 * 
 * @author Robert Scholte
 * @since 1.0.0
 */
public abstract class ResolvePathsRequest
{
    private Path jdkHome;

    private Path mainModuleDescriptor;

    private Collection pathElements;

    private Collection additionalModules;
    
    private boolean includeAllProviders;

    private JavaModuleDescriptor resolvedMainModuleDescriptor;

    private ResolvePathsRequest()
    {
    }

    /**
     * @deprecated use {@link #ofFiles(Collection)} instead
     */
    @Deprecated
    public static ResolvePathsRequest withFiles( Collection files )
    {
        return ofFiles( files );
    }
    
    public static ResolvePathsRequest ofFiles( File... files )
    {
        return ofFiles( Arrays.asList( files ) );
    }
    
    public static ResolvePathsRequest ofFiles( Collection files )
    {
        ResolvePathsRequest request = new ResolvePathsRequest()
        {
            @Override
            protected Path toPath( File t )
            {
                return t.toPath();
            }
        };

        request.pathElements = files;
        return request;
    }

    /**
     * @deprecated use {@link #ofPaths(Collection)} instead
     */
    @Deprecated
    public static ResolvePathsRequest withPaths( Collection paths )
    {
        return ofPaths( paths );
    }
    
    public static ResolvePathsRequest ofPaths( Path... paths )
    {
        return ofPaths( Arrays.asList( paths ) );
    }
    
    public static ResolvePathsRequest ofPaths( Collection paths )
    {
        ResolvePathsRequest request = new ResolvePathsRequest() {
            @Override
            protected Path toPath( Path t )
            {
                return t;
            }
        };
        request.pathElements = paths;
        return request;
    }

    /**
     * @deprecated use {@link #ofStrings(Collection)} instead
     */
    @Deprecated
    public static ResolvePathsRequest withStrings( Collection strings )
    {
        return ofStrings( strings );
    }
    
    public static ResolvePathsRequest ofStrings( String... strings )
    {
        return ofStrings( Arrays.asList( strings ) );
    }
    
    public static ResolvePathsRequest ofStrings( Collection strings )
    {
        ResolvePathsRequest request = new ResolvePathsRequest() {
            @Override
            protected Path toPath( String t )
            {
                return Paths.get( t );
            }
        };
        request.pathElements = strings;
        return request;
    }

    protected abstract Path toPath( T t );

    final ResolvePathsResult createResult() {
        return new ResolvePathsResult<>();
    }

    public Path getMainModuleDescriptor()
    {
        return mainModuleDescriptor;
    }

    public JavaModuleDescriptor getModuleDescriptor()
    {
        return resolvedMainModuleDescriptor;
    }
    
    /**
     * Must be either {@code module-info.java} or {@code module-info.class} 
     * 
     * @param mainModuleDescriptor
     * @return this request
     */
    public ResolvePathsRequest setMainModuleDescriptor( T mainModuleDescriptor )
    {
        this.mainModuleDescriptor = toPath( mainModuleDescriptor );
        return this;
    }

    /***
     * Provide a resolved module descriptor
     * 
     * @param mainModuleDescriptor
     * @return this request
     */
    public ResolvePathsRequest setModuleDescriptor( JavaModuleDescriptor mainModuleDescriptor )
    {
        this.resolvedMainModuleDescriptor = mainModuleDescriptor;
        return this;
    }

    public Collection getPathElements()
    {
        return pathElements;
    }

    /**
     * In case the JRE is Java 8 or before, this jdkHome is used to extract the module name.
     * 
     * @param jdkHome
     * @return this request
     */
    public ResolvePathsRequest setJdkHome( T jdkHome )
    {
        this.jdkHome = toPath( jdkHome );
        return this;
    }

    public Path getJdkHome()
    {
        return jdkHome;
    }

    /**
     * The module names that are usually passed with {@code --add-modules}
     * 
     * @param additionalModules
     * @return this request
     */
    public ResolvePathsRequest setAdditionalModules( Collection additionalModules )
    {
        this.additionalModules = additionalModules;
        return this;
    }

    public Collection getAdditionalModules()
    {
        if ( additionalModules == null )
        {
            additionalModules = Collections.emptyList();
        }
        return additionalModules;
    }
    
    /**
     * Will also include all modules that contain providers for used services, should only be used at runtime (not during compile nor test)
     * 
     * @param includeAllProviders
     * @return this request
     */
    public ResolvePathsRequest setIncludeAllProviders( boolean includeAllProviders )
    {
        this.includeAllProviders = includeAllProviders;
        return this;
    }
    
    public boolean isIncludeAllProviders()
    {
        return includeAllProviders;
    }
}