Package org.springframework.social.github.api.impl

Class GistTemplate

java.lang.Object

org.springframework.social.github.api.impl.GistTemplate

All Implemented Interfaces:

GistOperations

public class GistTemplate
extends Object
implements GistOperations

Gist template implementation.

Author:

Willie Wheeler (willie.wheeler@gmail.com)

Constructor Summary

Constructors

Constructor	Description
GistTemplate(org.springframework.web.client.RestTemplate restTemplate, boolean isAuthorizedForUser)

Method Summary

Modifier and Type	Method	Description
protected String	buildUri(String path)
GitHubGist	getGist(String id)	Returns the gist with the given ID.
GitHubComment	getGistComment(Long id)	Public operation to return a gist comment.
List<GitHubComment>	getGistComments(String id)	Public operation to return the comments on a given gist.
List<GitHubGist>	getGists()	If authenticated, this method returns the current user's gists.
List<GitHubGist>	getPublicGists()	Public operation to return all public gists.
List<GitHubGist>	getStarredGists()	Returns the authenticated user's starred gists.
List<GitHubGist>	getUserGists(String user)	Public operation to return the given user's public gists.
protected void	requireAuthorization()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GistTemplate

public GistTemplate(org.springframework.web.client.RestTemplate restTemplate,
                    boolean isAuthorizedForUser)

Parameters:

restTemplate - RestTemplate

isAuthorizedForUser - boolean

Method Detail

getUserGists

public List<GitHubGist> getUserGists(String user)

Description copied from interface: GistOperations

Public operation to return the given user's public gists.

Specified by:

getUserGists in interface GistOperations

Parameters:

user - GitHub user

Returns:

list of user's gists

getGists

public List<GitHubGist> getGists()

Description copied from interface: GistOperations

If authenticated, this method returns the current user's gists. Otherwise it returns all public gists.

Specified by:

getGists in interface GistOperations

Returns:

current user's gists, or else all public gists

getPublicGists

public List<GitHubGist> getPublicGists()

Description copied from interface: GistOperations

Public operation to return all public gists.

Specified by:

getPublicGists in interface GistOperations

Returns:

all public gists

getStarredGists

public List<GitHubGist> getStarredGists()

Description copied from interface: GistOperations

Returns the authenticated user's starred gists.

Specified by:

getStarredGists in interface GistOperations

Returns:

authenticated user's starred gists

getGist

public GitHubGist getGist(String id)

Description copied from interface: GistOperations

Returns the gist with the given ID.

Specified by:

getGist in interface GistOperations

Parameters:

id - gist ID

Returns:

gist

getGistComments

public List<GitHubComment> getGistComments(String id)

Description copied from interface: GistOperations

Public operation to return the comments on a given gist.

Specified by:

getGistComments in interface GistOperations

Parameters:

id - gist ID

Returns:

gist comments

getGistComment

public GitHubComment getGistComment(Long id)

Description copied from interface: GistOperations

Public operation to return a gist comment.

Specified by:

getGistComment in interface GistOperations

Parameters:

id - comment ID

Returns:

comment

requireAuthorization

protected void requireAuthorization()

buildUri

protected String buildUri(String path)