1 package org.eclipse.aether.collection;
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 import org.eclipse.aether.RepositorySystemSession;
23
24 /**
25 * A context used during dependency collection to exchange information within a chain of dependency graph transformers.
26 *
27 * @see DependencyGraphTransformer
28 * @noimplement This interface is not intended to be implemented by clients.
29 * @noextend This interface is not intended to be extended by clients.
30 */
31 public interface DependencyGraphTransformationContext
32 {
33
34 /**
35 * Gets the repository system session during which the graph transformation happens.
36 *
37 * @return The repository system session, never {@code null}.
38 */
39 RepositorySystemSession getSession();
40
41 /**
42 * Gets a keyed value from the context.
43 *
44 * @param key The key used to query the value, must not be {@code null}.
45 * @return The queried value or {@code null} if none.
46 */
47 Object get( Object key );
48
49 /**
50 * Puts a keyed value into the context.
51 *
52 * @param key The key used to store the value, must not be {@code null}.
53 * @param value The value to store, may be {@code null} to remove the mapping.
54 * @return The previous value associated with the key or {@code null} if none.
55 */
56 Object put( Object key, Object value );
57
58 }