Coverage Report - com.jcabi.github.Gitignores
 
Classes in this File Line Coverage Branch Coverage Complexity
Gitignores
N/A
N/A
1
 
 1  
 /**
 2  
  * Copyright (c) 2013-2017, jcabi.com
 3  
  * All rights reserved.
 4  
  *
 5  
  * Redistribution and use in source and binary forms, with or without
 6  
  * modification, are permitted provided that the following conditions
 7  
  * are met: 1) Redistributions of source code must retain the above
 8  
  * copyright notice, this list of conditions and the following
 9  
  * disclaimer. 2) Redistributions in binary form must reproduce the above
 10  
  * copyright notice, this list of conditions and the following
 11  
  * disclaimer in the documentation and/or other materials provided
 12  
  * with the distribution. 3) Neither the name of the jcabi.com nor
 13  
  * the names of its contributors may be used to endorse or promote
 14  
  * products derived from this software without specific prior written
 15  
  * permission.
 16  
  *
 17  
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 18  
  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
 19  
  * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 20  
  * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
 21  
  * THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 22  
  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 23  
  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 24  
  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 25  
  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 26  
  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 27  
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 28  
  * OF THE POSSIBILITY OF SUCH DAMAGE.
 29  
  */
 30  
 package com.jcabi.github;
 31  
 
 32  
 import com.jcabi.aspects.Immutable;
 33  
 import java.io.IOException;
 34  
 
 35  
 /**
 36  
  * Github Gitignore.
 37  
  * <p>Defines storage of .gitignore templates
 38  
  *
 39  
  * @author Paul Polishchuk (ppol@ua.fm)
 40  
  * @version $Id: bca70871088f2602c5733a77c09f203a7e180af5 $
 41  
  * @see <a href="http://developer.github.com/v3/gitignore/#gitignore">Gitignore</a>
 42  
  * @since 0.8
 43  
  */
 44  
 @Immutable
 45  
 public interface Gitignores {
 46  
     /**
 47  
      * Get its owner.
 48  
      * @return Github
 49  
      */
 50  
     Github github();
 51  
 
 52  
     /**
 53  
      * Iterate them all.
 54  
      * @return Iterator of Gitignote template names
 55  
      * @throws IOException If it fails due to I/O problem
 56  
      * @see <a href="http://developer.github.com/v3/gitignore/#listing-available-templates">Listing available templates</a>
 57  
      */
 58  
     Iterable<String> iterate() throws IOException;
 59  
 
 60  
     /**
 61  
      * Gets raw gitignore template.
 62  
      * @param name Name of the template
 63  
      * @return Raw template
 64  
      * @throws IOException If it fails due to I/O problem
 65  
      */
 66  
     String template(String name) throws IOException;
 67  
 }