com.jcabi.github

Interface Gitignores

@Immutable
public interface Gitignores

Github Gitignore.

Defines storage of .gitignore templates

Since:

0.8

Version:

$Id$

Author:

Paul Polishchuk (ppol@ua.fm)

See Also:

Gitignore

Method Summary

Methods

Modifier and Type	Method and Description
Github	github() Get its owner.
Iterable<String>	iterate() Iterate them all.
String	template(String name) Gets raw gitignore template.

Method Detail

github

@NotNull(message="github is never NULL")
Github github()

Get its owner.

Returns:

Github

iterate

@NotNull(message="iterable is never NULL")
Iterable<String> iterate()
                         throws IOException

Iterate them all.

Returns:

Iterator of Gitignote template names

Throws:

IOException - If it fails due to I/O problem

See Also:

Listing available templates

template

@NotNull(message="Raw template is never NULL")
String template(@NotNull(message="Template name can\'t be NULL")
                             String name)
                throws IOException

Gets raw gitignore template.

Parameters:

name - Name of the template

Returns:

Raw template

Throws:

IOException - If it fails due to I/O problem