001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.eclipse.aether.spi.artifact.decorator;
020
021import org.eclipse.aether.artifact.Artifact;
022import org.eclipse.aether.resolution.ArtifactDescriptorResult;
023
024/**
025 * An artifact decorator.
026 *
027 * @since 2.0.0
028 */
029public interface ArtifactDecorator {
030    /**
031     * A "no op" decorator. Usable by factories if factory does not want to decorate, as factory must return
032     * non-{@code null} decorator instance.
033     */
034    ArtifactDecorator NOOP = new ArtifactDecorator() {
035        @Override
036        public Artifact decorateArtifact(ArtifactDescriptorResult artifactDescriptorResult) {
037            return artifactDescriptorResult.getArtifact();
038        }
039    };
040
041    /**
042     * Decorates artifact.
043     *
044     * @param artifactDescriptorResult the artifact descriptor result of artifact, never {@code null}.
045     * @return The decorated artifact, must never return {@code null}.
046     */
047    Artifact decorateArtifact(ArtifactDescriptorResult artifactDescriptorResult);
048}