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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of plexus-java Show documentation
There is a newer version: 1.3.0
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.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.Map;

/**
 * Holds the results of the project analyzer
 *
 * @author Robert Scholte
 * @since 1.0.0
 */
public class ResolvePathsResult {
    private JavaModuleDescriptor mainModuleDescriptor;

    /**
     * Ordered map, respects the classpath order
     */
    private Map pathElements;

    private Map modulepathElements = new LinkedHashMap<>();

    private Collection classpathElements = new ArrayList<>();

    private Map pathExceptions = new HashMap<>();

    void setMainModuleDescriptor(JavaModuleDescriptor mainModuleDescriptor) {
        this.mainModuleDescriptor = mainModuleDescriptor;
    }

    /**
     * The resolved main module descriptor
     *
     * @return the resolved descriptor
     * @see ResolvePathsRequest#setMainModuleDescriptor(Object)
     */
    public JavaModuleDescriptor getMainModuleDescriptor() {
        return mainModuleDescriptor;
    }

    void setPathElements(Map pathElements) {
        this.pathElements = pathElements;
    }

    /**
     * Ordered map, respects the classpath order
     */
    public Map getPathElements() {
        return pathElements;
    }

    void setClasspathElements(Collection classpathElements) {
        this.classpathElements = classpathElements;
    }

    /**
     * All T that belong to the classpath based on the module descriptor
     *
     * @return the classpath elements, never {@code null}
     * @see #getPathElements()
     */
    public Collection getClasspathElements() {
        return classpathElements;
    }

    void setModulepathElements(Map modulepathElements) {
        this.modulepathElements = modulepathElements;
    }

    /**
     * All T that belong to the modulepath, based on the module descriptor.
     * For every T the source for the module name is added.
     *
     * @return all modulepath elements, never {@code null}
     * @see #getPathElements()
     */
    public Map getModulepathElements() {
        return modulepathElements;
    }

    void setPathExceptions(Map pathExceptions) {
        this.pathExceptions = pathExceptions;
    }

    /**
     * Map containing exceptions for every T which modulename resolution failed
     *
     * @return the exceptions for every T, never {@code null}
     */
    public Map getPathExceptions() {
        return pathExceptions;
    }

    @Override
    public String toString() {
        return "ResolvePathsResult{" + System.lineSeparator() + "mainModuleDescriptor="
                + mainModuleDescriptor + System.lineSeparator() + ", pathElements="
                + pathElements + System.lineSeparator() + ", modulepathElements="
                + modulepathElements + System.lineSeparator() + ", classpathElements="
                + classpathElements + System.lineSeparator() + ", pathExceptions="
                + pathExceptions + System.lineSeparator() + '}';
    }
}