org.gradle.api.provider.ListProperty 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

Gradle 6.9.1 API redistribution.

There is a newer version: 8.11.1

/*
 * Copyright 2017 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.provider;

import javax.annotation.Nullable;
import java.util.List;

/**
 * Represents a property whose type is a {@link List} of elements of type {@link T}.
 *
 * 
 * You can create a {@link ListProperty} instance using factory method {@link org.gradle.api.model.ObjectFactory#listProperty(Class)}.
 * 
 *
 * Note: This interface is not intended for implementation by build script or plugin authors.
 *
 * @param  the type of elements.
 * @since 4.3
 */
public interface ListProperty extends Provider>, HasMultipleValues {
    /**
     * {@inheritDoc}
     */
    @Override
    ListProperty empty();

    /**
     * {@inheritDoc}
     */
    @Override
    ListProperty value(@Nullable Iterable elements);

    /**
     * {@inheritDoc}
     */
    @Override
    ListProperty value(Provider> provider);

    /**
     * {@inheritDoc}
     */
    @Override
    ListProperty convention(@Nullable Iterable elements);

    /**
     * {@inheritDoc}
     */
    @Override
    ListProperty convention(Provider> provider);

    /**
     * {@inheritDoc}
     *
     * 

     * This is similar to calling {@link #value(Iterable)} with a null argument.
     * 
     */
    @Override
    ListProperty unset();

    /**
     * {@inheritDoc}
     *
     * 
     * This is similar to calling {@link #convention(Iterable)} with a null argument.
     * 
     */
    @Override
    ListProperty unsetConvention();
}