Package com.jcabi.github
Interface References
@Immutable
public interface References
GitHub Git Data References.
- Since:
- 0.8
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionCreates a reference.Get Reference by identifier.heads()Iterate references under "heads" sub-namespace.iterate()Iterates all references.Iterates references in sub-namespace.voidRemoves a reference by its identifier.repo()Owner of them.tags()Iterate references under "tags" sub-namespace.
-
Method Details
-
repo
Repo repo()Owner of them.- Returns:
- Repo
-
create
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
Get Reference by identifier.- Parameters:
identifier- Reference's name.- Returns:
- Reference The reference with the given name
-
iterate
Iterates all references.- Returns:
- Iterator of references.
-
iterate
Iterates references in sub-namespace.- Parameters:
subnamespace- Sub-namespace- Returns:
- Iterator of references.
-
tags
Iterate references under "tags" sub-namespace.- Returns:
- Iterator of references.
-
heads
Iterate references under "heads" sub-namespace.- Returns:
- Iterator of references.
-
remove
Removes a reference by its identifier.- Parameters:
identifier- Reference's identifier.- Throws:
IOException- If there is any I/O problem.
-