com.telenav.cactus.maven.refactoring.PomRole Maven / Gradle / Ivy
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
//
// © 2011-2022 Telenav, Inc.
//
// Licensed 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
//
// https://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 com.telenav.cactus.maven.refactoring;
import java.util.ArrayList;
import java.util.EnumSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.function.BiConsumer;
import static com.mastfrog.util.preconditions.Checks.notNull;
import static java.lang.Integer.max;
/**
* Roles a POM file can play within a project tree. A pom may have multiple
* roles. This information is used, among other things, to determine how its
* version should be adjusted when performing automated version changes.
*
* @see PomCategories
* @author Tim Boudreau
*/
public enum PomRole
{
/**
* This pom is used as a parent by some other one.
*/
PARENT,
/**
* This pom has a <modules> section.
*/
BILL_OF_MATERIALS,
/**
* This pom may provide properties to other poms which use it as a parent,
* but it has a parent, so other poms' properties may also be provided
* through it.
*/
CONFIG,
/**
* This pom provides properties to other poms which use it as a parent, and
* it has no parent.
*/
CONFIG_ROOT,
/**
* This pom represents a non-pom (jar, maven-plugin, nbm, something else)
* project.
*/
JAVA,
/**
* A UFO - its role cannot be determined - should not be encountered but
* present for completeness and debugging.
*/
UNKNOWN;
@Override
public String toString()
{
return name().replace('_', '-').toLowerCase();
}
@SuppressWarnings("ManualArrayToCollectionCopy")
public static Set setOf(PomRole first, PomRole... more)
{
// Efficiently creates a set
Set result = EnumSet.of(notNull("first", first));
for (int i = 0; i < more.length; i++)
{
result.add(more[i]);
}
return result;
}
public static > void visitMapEntriesSorted(
Map> map, BiConsumer> roleConsumer)
{
List>> entries = new ArrayList<>(
map.entrySet());
entries.sort((a, b) ->
{
int result = Integer.compare(maxOrdinal(a.getValue()),
maxOrdinal(b.getValue()));
if (result == 0)
{
result = a.getKey().compareTo(b.getKey());
}
return result;
});
entries.forEach(entry ->
{
roleConsumer.accept(entry.getKey(), entry.getValue());
});
}
private static > int maxOrdinal(Set set)
{
int result = -1;
for (E e : set)
{
result = max(result, e.ordinal());
}
return result;
}
}