org.jboss.forge.addon.git.facet

Interface GitIgnoreFacet

All Superinterfaces:

Facet<Project>, ProjectFacet

public interface GitIgnoreFacet
extends ProjectFacet

Downloads a list of .gitignore templates.

Author:

Lincoln Baxter, III, Jevgeni Zelenkov

Method Summary

Modifier and Type	Method and Description
String	contentOf(String template) Read the content of a gitignore template
List<GitIgnoreTemplateGroup>	list() List all available gitignore templates.
void	update() Update the templates from the remote repository.

Methods inherited from interface org.jboss.forge.addon.facets.Facet

getFaceted, install, isInstalled, uninstall

Method Detail

list

List<GitIgnoreTemplateGroup> list()

List all available gitignore templates.

contentOf

String contentOf(String template)

Read the content of a gitignore template

Parameters:

template - Template name.

Returns:

Template content as string.

update

void update()
     throws IOException,
            org.eclipse.jgit.api.errors.GitAPIException

Update the templates from the remote repository.

Throws:

IOException - Failure reading the git repository.

org.eclipse.jgit.api.errors.GitAPIException - Git failure.