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