org.apache.maven.repository.metadata.ClasspathContainer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of maven-compat Show documentation
Maven2 classes maintained as compatibility layer.
There is a newer version: 4.0.0-rc-2
/*
 * 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.maven.repository.metadata;

import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;

import org.apache.maven.artifact.ArtifactScopeEnum;

/**
 * classpath container that is aware of the classpath scope
 *
 * @author Oleg Gusakov
 *
 */
public class ClasspathContainer implements Iterable {
    private List classpath;

    private ArtifactScopeEnum scope;

    // -------------------------------------------------------------------------------------------
    public ClasspathContainer(ArtifactScopeEnum scope) {
        this.scope = ArtifactScopeEnum.checkScope(scope);
    }

    // -------------------------------------------------------------------------------------------
    public ClasspathContainer(List classpath, ArtifactScopeEnum scope) {
        this(scope);
        this.classpath = classpath;
    }

    // -------------------------------------------------------------------------------------------
    public Iterator iterator() {
        return classpath == null ? null : classpath.iterator();
    }

    // -------------------------------------------------------------------------------------------
    public ClasspathContainer add(ArtifactMetadata md) {
        if (classpath == null) {
            classpath = new ArrayList<>(16);
        }

        classpath.add(md);

        return this;
    }

    // -------------------------------------------------------------------------------------------
    public List getClasspath() {
        return classpath;
    }

    // -------------------------------------------------------------------------------------------
    public MetadataTreeNode getClasspathAsTree() throws MetadataResolutionException {
        if (classpath == null || classpath.size() < 1) {
            return null;
        }

        MetadataTreeNode tree = null;
        MetadataTreeNode parent = null;

        for (ArtifactMetadata md : classpath) {
            MetadataTreeNode node = new MetadataTreeNode(md, parent, md.isResolved(), md.getArtifactScope());
            if (tree == null) {
                tree = node;
            }

            if (parent != null) {
                parent.setNChildren(1);
                parent.addChild(0, node);
            }

            parent = node;
        }
        return tree;
    }

    public void setClasspath(List classpath) {
        this.classpath = classpath;
    }

    public ArtifactScopeEnum getScope() {
        return scope;
    }

    public void setScope(ArtifactScopeEnum scope) {
        this.scope = scope;
    }

    // -------------------------------------------------------------------------------------------
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder(256);
        sb.append("[scope=").append(scope.getScope());
        if (classpath != null) {
            for (ArtifactMetadata md : classpath) {
                sb.append(": ")
                        .append(md.toString())
                        .append('{')
                        .append(md.getArtifactUri())
                        .append('}');
            }
        }
        sb.append(']');
        return sb.toString();
    }
    // -------------------------------------------------------------------------------------------
    // -------------------------------------------------------------------------------------------
}