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.project;
20
21 import java.io.File;
22 import java.util.List;
23
24 /**
25 * Convenience interface for plugins to add or replace artifacts and resources on projects.
26 */
27 public interface MavenProjectHelper {
28 String ROLE = MavenProjectHelper.class.getName();
29
30 /**
31 * See {@link #attachArtifact(MavenProject, String, String, java.io.File)}, but with type set to null.
32 * @param project project reference.
33 * @param artifactFile artifact file.
34 * @param artifactClassifier artifact classifier.
35 */
36 void attachArtifact(MavenProject project, File artifactFile, String artifactClassifier);
37
38 /**
39 * * See {@link #attachArtifact(MavenProject, String, String, java.io.File)}, but with classifier set to null.
40 * @param project project reference.
41 * @param artifactType artifact type.
42 * @param artifactFile artifact file.
43 */
44 void attachArtifact(MavenProject project, String artifactType, File artifactFile);
45
46 /**
47 * Add or replace an artifact to the current project.
48 * @param project the project reference.
49 * @param artifactType the type (e.g. jar) or null.
50 * @param artifactClassifier the classifier or null.
51 * @param artifactFile the file for the artifact.
52 */
53 void attachArtifact(MavenProject project, String artifactType, String artifactClassifier, File artifactFile);
54
55 /**
56 * Add a resource directory to the project.
57 * @param project project reference.
58 * @param resourceDirectory directory.
59 * @param includes include patterns.
60 * @param excludes exclude patterns.
61 */
62 void addResource(MavenProject project, String resourceDirectory, List<String> includes, List<String> excludes);
63
64 /**
65 * Add a test resource directory to the project.
66 * @param project project reference.
67 * @param resourceDirectory directory.
68 * @param includes include patterns.
69 * @param excludes exclude patterns.
70 */
71 void addTestResource(MavenProject project, String resourceDirectory, List<String> includes, List<String> excludes);
72 }