com.jcabi.github

Interface References

@Immutable
public interface References

Github Git Data References.

Since:

0.8

Version:

$Id$

Author:

Carlos Miranda (miranda.cma@gmail.com)

See Also:

References API

Method Summary

Methods

Modifier and Type	Method and Description
Reference	create(String ref, String sha) Creates a reference.
Reference	get(String identifier) Get Reference by identifier.
Iterable<Reference>	heads() Iterate references under "heads" sub-namespace.
Iterable<Reference>	iterate() Iterates all references.
Iterable<Reference>	iterate(String subnamespace) Iterates references in sub-namespace.
void	remove(String identifier) Removes a reference by its identifier.
Repo	repo() Owner of them.
Iterable<Reference>	tags() Iterate references under "tags" sub-namespace.

Method Detail

repo

@NotNull(message="repository is never null")
Repo repo()

Owner of them.

Returns:

Repo

create

@NotNull(message="reference is never null")
Reference create(@NotNull(message="ref can\'t be NULL")
                              String ref,
                              @NotNull(message="sha can\'t be NULL")
                              String sha)
                 throws IOException

Creates a reference.

Parameters:

ref - The name of the fully qualified reference (ie: refs/heads/master).

sha - The SHA1 value to set this reference to.

Returns:

Reference - The newly created Reference

Throws:

IOException - - If there are any errors.

get

@NotNull(message="reference is never null")
Reference get(@NotNull(message="identifier can\'t be null")
                           String identifier)

Get Reference by identifier.

Parameters:

identifier - Reference's name.

Returns:

Reference The reference with the given name

iterate

@NotNull(message="iterable is never NULL")
Iterable<Reference> iterate()

Iterates all references.

Returns:

Iterator of references.

iterate

@NotNull(message="iterable is never NULL")
Iterable<Reference> iterate(@NotNull(message="identifier can\'t be null")
                                         String subnamespace)

Iterates references in sub-namespace.

Parameters:

subnamespace - Sub-namespace

Returns:

Iterator of references.

tags

@NotNull(message="iterable of tags is never NULL")
Iterable<Reference> tags()

Iterate references under "tags" sub-namespace.

Returns:

Iterator of references.

heads

@NotNull(message="iterable of heads is never NULL")
Iterable<Reference> heads()

Iterate references under "heads" sub-namespace.

Returns:

Iterator of references.

remove

void remove(@NotNull(message="identifier can\'t be NULL")
          String identifier)
            throws IOException

Removes a reference by its identifier.

Parameters:

identifier - Reference's identifier.

Throws:

IOException - If there is any I/O problem.