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.spi.artifact.decorator;
20
21 import org.eclipse.aether.artifact.Artifact;
22 import org.eclipse.aether.resolution.ArtifactDescriptorResult;
23
24 /**
25 * An artifact decorator.
26 *
27 * @since 2.0.0
28 */
29 public interface ArtifactDecorator {
30 /**
31 * A "no op" decorator. Usable by factories if factory does not want to decorate, as factory must return
32 * non-{@code null} decorator instance.
33 */
34 ArtifactDecorator NOOP = new ArtifactDecorator() {
35 @Override
36 public Artifact decorateArtifact(ArtifactDescriptorResult artifactDescriptorResult) {
37 return artifactDescriptorResult.getArtifact();
38 }
39 };
40
41 /**
42 * Decorates artifact.
43 *
44 * @param artifactDescriptorResult the artifact descriptor result of artifact, never {@code null}.
45 * @return The decorated artifact, must never return {@code null}.
46 */
47 Artifact decorateArtifact(ArtifactDescriptorResult artifactDescriptorResult);
48 }