org.gradle.api.internalivyservice.resolveengine.artifact.ArtifactVisitor Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of gradle-api Show documentation
Show all versions of gradle-api Show documentation
Gradle 6.9.1 API redistribution.
/*
* Copyright 2016 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.gradle.api.internal.artifacts.ivyservice.resolveengine.artifact;
import org.gradle.api.attributes.AttributeContainer;
import org.gradle.api.internal.file.FileCollectionInternal;
import org.gradle.api.internal.file.FileCollectionStructureVisitor;
import org.gradle.internal.DisplayName;
/**
* A visitor over the contents of a {@link ResolvedArtifactSet}. A {@link ResolvedArtifactSet} may contain zero or more sets of files, each set containing zero or more artifacts.
*/
public interface ArtifactVisitor {
/**
* Called prior to scheduling resolution of a set of artifacts. Should be called in result order.
*/
default FileCollectionStructureVisitor.VisitType prepareForVisit(FileCollectionInternal.Source source) {
return FileCollectionStructureVisitor.VisitType.Visit;
}
/**
* Visits an artifact. Artifacts are resolved but not necessarily available unless {@link #requireArtifactFiles()} returns true.
*/
void visitArtifact(DisplayName variantName, AttributeContainer variantAttributes, ResolvableArtifact artifact);
/**
* Should the file for each artifacts be made available prior to calling {@link #visitArtifact(DisplayName, AttributeContainer, ResolvableArtifact)}?
*
* Returns true here allows the collection to preemptively resolve the files in parallel.
*/
boolean requireArtifactFiles();
/**
* Called when some problem occurs visiting some element of the set. Visiting may continue.
*/
void visitFailure(Throwable failure);
/**
* Called for a set that may be backed by a file collection, when {@link #prepareForVisit(FileCollectionInternal.Source)} return {@link FileCollectionStructureVisitor.VisitType#Spec}.
*/
default void visitSpec(FileCollectionInternal spec) {
}
/**
* Called after a set of artifacts has been visited.
*/
default void endVisitCollection(FileCollectionInternal.Source source) {
}
}