Groovy Documentation

org.gradle.api.plugins.github
[Java] Interface GitHubDownloadsRepository

org.gradle.api.artifacts.repositories.ArtifactRepository
  org.gradle.api.plugins.github.GitHubDownloadsRepository
      org.gradle.api.artifacts.repositories.AuthenticationSupported
All Superinterfaces:
ArtifactRepository, AuthenticationSupported

@Incubating
public interface GitHubDownloadsRepository
extends ArtifactRepository, AuthenticationSupported

A dependency repository that uses GitHub downloads as the source. A value for setUser(String) must be provided before this can be used.

Given the following repository definition:

 repositories {
     github.downloads {
       user = "githubUser"
     }
 }

The following dependency notations will resolve to:


Field Summary
String DOWNLOADS_URL_BASE

{@value #DOWNLOADS_URL_BASE}

 
Method Summary
URI getBaseUrl()

The base GitHub downloads url.

String getUser()

The GitHub user/organisation name that houses the downloads.

void setBaseUrl(Object baseUrl)

Override the default base url of '{@value #DOWNLOADS_URL_BASE}'

void setUser(String user)

Sets the GitHub user/organisation name that houses the downloads.

 
Methods inherited from interface ArtifactRepository
getName, setName
 
Methods inherited from interface AuthenticationSupported
credentials, getCredentials
 

Field Detail

DOWNLOADS_URL_BASE

public String DOWNLOADS_URL_BASE
{
value:
#DOWNLOADS_URL_BASE}


 
Method Detail

getBaseUrl

public URI getBaseUrl()
The base GitHub downloads url. Defaults to '{
value:
#DOWNLOADS_URL_BASE}'
Returns:
The base GitHub downloads url.


getUser

public String getUser()
The GitHub user/organisation name that houses the downloads.
Returns:
The GitHub user/organisation name that houses the downloads.


setBaseUrl

public void setBaseUrl(Object baseUrl)
Override the default base url of '{
value:
#DOWNLOADS_URL_BASE}'
Parameters:
baseUrl - The new base url


setUser

public void setUser(String user)
Sets the GitHub user/organisation name that houses the downloads. Given a GitHub Downloads URL, this is the value at {
value:
#DOWNLOADS_URL_BASE}/«user».
Parameters:
user - The GitHub user/organisation name that houses the downloads.


 

Gradle API 1.3-rc-2