indexer-core/src/main/java/org/apache/maven/index/ArtifactInfoGroup.java

package org.apache.maven.index;

/*
 * 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.Comparator;
import java.util.Set;
import java.util.TreeSet;

/**
 * An object that holds grouped sets of {@link ArtifactInfos} in case of grouped search.
 * 
 * @author Tamas Cservenak
 */
public class ArtifactInfoGroup
{
    private String groupKey;

    public final Set<ArtifactInfo> artifactInfos;

    public ArtifactInfoGroup( String groupKey )
    {
        this( groupKey, ArtifactInfo.VERSION_COMPARATOR );
    }

    public ArtifactInfoGroup( String groupKey, Comparator<ArtifactInfo> comparator )
    {
        this.groupKey = groupKey;

        this.artifactInfos = new TreeSet<ArtifactInfo>( comparator );
    }

    public String getGroupKey()
    {
        return groupKey;
    }

    public boolean addArtifactInfo( ArtifactInfo artifactInfo )
    {
        return artifactInfos.add( artifactInfo );
    }

    public Set<ArtifactInfo> getArtifactInfos()
    {
        return artifactInfos;
    }

    @Override
    public String toString()
    {
        return new StringBuilder().append( groupKey ).append( "=" ).append( artifactInfos.toString() ).toString();
    }

}