org.gradle.apiComponentMetadataContext Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2018 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.artifacts;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

/**
 * Provides access to component metadata from a {@link ComponentMetadataRule}.
 *
 * @since 4.9
 */
public interface ComponentMetadataContext {

    /**
     * Used to access a specific descriptor format.
     *
     * @param descriptorClass the descriptor class
     * @param  the descriptor type
     *
     * @return a descriptor, or {@code null} if there was none of the requested type.
     *
     * @see org.gradle.api.artifacts.ivy.IvyModuleDescriptor
     * @see org.gradle.api.artifacts.maven.PomModuleDescriptor
     */
    @Nullable
     T getDescriptor(Class descriptorClass);

    @Nonnull
    ComponentMetadataDetails getDetails();
}