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.apache.maven.api;
20
21 import java.util.Map;
22
23 import org.apache.maven.api.annotations.Experimental;
24 import org.apache.maven.api.annotations.Immutable;
25 import org.apache.maven.api.annotations.Nonnull;
26
27 /**
28 * Dependency properties supported by Maven Core.
29 *
30 * @since 4.0.0
31 */
32 @Experimental
33 @Immutable
34 public interface DependencyProperties {
35 /**
36 * Boolean flag telling that dependency contains all of its dependencies. Value of this key should be parsed with
37 * {@link Boolean#parseBoolean(String)} to obtain value.
38 * <p>
39 * <em>Important: this flag must be kept in sync with resolver! (as is used during collection)</em>
40 */
41 String FLAG_INCLUDES_DEPENDENCIES = "includesDependencies";
42
43 /**
44 * Boolean flag telling that dependency is meant to be placed on class path. Value of this key should be parsed with
45 * {@link Boolean#parseBoolean(String)} to obtain value.
46 */
47 String FLAG_CLASS_PATH_CONSTITUENT = "classPathConstituent";
48
49 /**
50 * Returns immutable "map view" of all the properties.
51 */
52 @Nonnull
53 Map<String, String> asMap();
54
55 /**
56 * Returns {@code true} if given flag is {@code true}.
57 */
58 boolean checkFlag(@Nonnull String flag);
59 }