1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.eclipse.aether.util.graph.transformer;
20
21 /**
22 * A collection of keys used by the dependency graph transformers when exchanging information via the graph
23 * transformation context.
24 *
25 * @see org.eclipse.aether.collection.DependencyGraphTransformationContext#get(Object)
26 */
27 public final class TransformationContextKeys {
28
29 /**
30 * The key in the graph transformation context where a {@code Map<DependencyNode, Object>} is stored which maps
31 * dependency nodes to their conflict ids. All nodes that map to an equal conflict id belong to the same group of
32 * conflicting dependencies. Note that the map keys use reference equality.
33 *
34 * @see ConflictMarker
35 */
36 public static final Object CONFLICT_IDS = "conflictIds";
37
38 /**
39 * The key in the graph transformation context where a {@code List<Object>} is stored that denotes a topological
40 * sorting of the conflict ids.
41 *
42 * @see ConflictIdSorter
43 */
44 public static final Object SORTED_CONFLICT_IDS = "sortedConflictIds";
45
46 /**
47 * The key in the graph transformation context where a {@code Collection<Collection<Object>>} is stored that denotes
48 * cycles among conflict ids. Each element in the outer collection denotes one cycle, i.e. if the collection is
49 * empty, the conflict ids have no cyclic dependencies.
50 *
51 * @see ConflictIdSorter
52 */
53 public static final Object CYCLIC_CONFLICT_IDS = "cyclicConflictIds";
54
55 /**
56 * The key in the graph transformation context where a {@code Map<String, Object>} is stored that can be used to
57 * include some runtime/performance stats in the debug log. If this map is not present, no stats should be recorded.
58 */
59 public static final Object STATS = "stats";
60
61 private TransformationContextKeys() {
62 // hide constructor
63 }
64 }