org.gradle.vcs.git.GitVersionControlSpec 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.vcs.git;

import org.gradle.api.Incubating;
import org.gradle.vcs.VersionControlSpec;

import java.net.URI;

/**
 * A specification of a Git repository.
 *
 * @since 4.4
 */
@Incubating
public interface GitVersionControlSpec extends VersionControlSpec {
    /**
     * The URL for the repository in the specification.
     *
     * Note: The return value is a {@link URI} to avoid exposing the
     * full contract of {@link java.net.URL} clients of this interface.
     * Specifically, {@link java.net.URL} extends {@link URI} to add network
     * operations which are both unsuited for simple data specification and
     * allocate additional memory.
     */
    URI getUrl();

    /**
     * Sets the URL of the repository.
     */
    void setUrl(URI url);

    /**
     * Sets the URL of the repository.
     */
    void setUrl(String url);
}