Coverage Report - com.jcabi.github.RepoCommits
 
Classes in this File Line Coverage Branch Coverage Complexity
RepoCommits
N/A
N/A
1
 
 1  
 /**
 2  
  * Copyright (c) 2013-2015, 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  
 import java.util.Map;
 35  
 import javax.validation.constraints.NotNull;
 36  
 
 37  
 /**
 38  
  * Commits of a Github repository.
 39  
  * @author Alexander Sinyagin (sinyagin.alexander@gmail.com)
 40  
  * @version $Id$
 41  
  * @see <a href="http://developer.github.com/v3/repos/commits/">Commits API</a>
 42  
  */
 43  
 @Immutable
 44  
 @SuppressWarnings("PMD.AvoidDuplicateLiterals")
 45  
 public interface RepoCommits extends JsonReadable {
 46  
 
 47  
     /**
 48  
      * Iterate all repository's commits.
 49  
      * @return All commits
 50  
      * @param params Url's parameters
 51  
      * @see <a href="http://developer.github.com/v3/repos/commits/#list-commits-on-a-repository">List commits on a repository</a>
 52  
      */
 53  
     @NotNull(message = "iterable is never NULL")
 54  
     Iterable<RepoCommit> iterate(
 55  
         @NotNull(message = "params can't be NULL")
 56  
         final Map<String, String> params
 57  
     );
 58  
 
 59  
     /**
 60  
      * Get single repository's commits.
 61  
      *
 62  
      * @param sha SHA of a commit
 63  
      * @return RepoCommit
 64  
      * @see <a href="http://developer.github.com/v3/repos/commits/#get-a-single-commit">Get a single commit</a>
 65  
      */
 66  
     @NotNull(message = "RepoCommit is never NULL")
 67  
     RepoCommit get(@NotNull(message = "sha is never NULL") String sha);
 68  
 
 69  
     /**
 70  
      * Compare two commits.
 71  
      * @param base SHA of the base repo commit
 72  
      * @param head SHA of the head repo commit
 73  
      * @return Commits comparison
 74  
      */
 75  
     @NotNull(message = "repo commits comparison is never NULL")
 76  
     CommitsComparison compare(
 77  
         @NotNull(message = "base is never NULL") String base,
 78  
         @NotNull(message = "base is never NULL") String head);
 79  
 
 80  
     /**
 81  
      * Compare two commits and provide result in diff format.
 82  
      * @param base SHA of the base repo commit
 83  
      * @param head SHA of the head repo commit
 84  
      * @return Commits comparison
 85  
      * @throws IOException If there is any I/O problem
 86  
      * @since 0.8
 87  
      */
 88  
     @NotNull(message = "repo commits comparison is never NULL")
 89  
     String diff(
 90  
         @NotNull(message = "base is never NULL") String base,
 91  
         @NotNull(message = "head is never NULL") String head
 92  
     ) throws IOException;
 93  
 
 94  
     /**
 95  
      * Compare two commits and provide result in patch format.
 96  
      * @param base SHA of the base repo commit
 97  
      * @param head SHA of the head repo commit
 98  
      * @return Commits comparison
 99  
      * @throws IOException If there is any I/O problem
 100  
      * @since 0.8
 101  
      */
 102  
     @NotNull(message = "repo commits comparison is never NULL")
 103  
     String patch(
 104  
         @NotNull(message = "base is never NULL") String base,
 105  
         @NotNull(message = "head is never NULL") String head
 106  
     ) throws IOException;
 107  
 }