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.collection;
020
021import java.util.List;
022
023import org.eclipse.aether.graph.Dependency;
024import org.eclipse.aether.graph.DependencyNode;
025
026/**
027 * A trace data object revealing collect step (while executing {@link CollectRequest}.
028 *
029 * @see org.eclipse.aether.RequestTrace
030 * @since 1.8.1
031 * @noimplement This interface is not intended to be implemented by clients.
032 * @noextend This interface is not intended to be extended by clients.
033 */
034public interface CollectStepData {
035    /**
036     * Returns the context of collection. Never {@code null}.
037     */
038    String getContext();
039
040    /**
041     * Returns the path of dependency nodes that led collector to current node returned by {@link #getNode()}.
042     * Never {@code null}.
043     */
044    List<DependencyNode> getPath();
045
046    /**
047     * Returns the current node being collected. Never {@code null}.
048     */
049    Dependency getNode();
050}