TaskPropertyBuilder.java

/*
 * 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.tasks;

import org.gradle.api.Incubating;
import org.gradle.internal.HasInternalProtocol;

/**
 * Describes a property of a task.
 *
 * @since 3.0
 */
@Incubating
@HasInternalProtocol
public interface TaskPropertyBuilder {
    /**
     * Sets the name for this property. The name must be a valid Java identifier,
     * or a series of valid Java identifiers separated with dots ('.').
     *
     * <p>If the method is not called, or if it is called with {@code null}, a name
     * will be assigned to the property automatically.</p>
     */
    TaskPropertyBuilder withPropertyName(String propertyName);
}