Coverage Report - com.jcabi.github.Milestones
 
Classes in this File Line Coverage Branch Coverage Complexity
Milestones
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  
  * Github Milestones.
 39  
  * @author Paul Polishchuk (ppol@ua.fm)
 40  
  * @version $Id$
 41  
  * @see <a href="http://developer.github.com/v3/issues/milestones/">Milestones API</a>
 42  
  * @since 0.7
 43  
  */
 44  
 @Immutable
 45  
 public interface Milestones {
 46  
 
 47  
     /**
 48  
      * Owner of them.
 49  
      * @return Repo
 50  
      */
 51  
     @NotNull(message = "repository is never NULL")
 52  
     Repo repo();
 53  
 
 54  
     /**
 55  
      * Create Milestone.
 56  
      * @param title Milestone creation JSON
 57  
      * @return Milestone
 58  
      * @throws java.io.IOException If there is any I/O problem
 59  
      * @see <a href="http://developer.github.com/v3/issues/milestones/#create-a-milestone">Create Milestone</a>
 60  
      * @since 0.5
 61  
      */
 62  
     @NotNull(message = "repository is never NULL")
 63  
     Milestone create(@NotNull(message = "Title can't be NULL") String title)
 64  
         throws IOException;
 65  
 
 66  
     /**
 67  
      * Get specific milestone by number.
 68  
      * @param number Milestone number
 69  
      * @return Milestone
 70  
      * @see <a href="http://developer.github.com/v3/issues/milestones/#get-a-single-milestone">Get a single milestone</a>
 71  
      */
 72  
     @NotNull(message = "milestone is never NULL")
 73  
     Milestone get(int number);
 74  
 
 75  
     /**
 76  
      * Iterate them all.
 77  
      * @param params Iterating parameters, as requested by API
 78  
      * @return Iterator of milestones
 79  
      * @see <a href="http://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository">List milestones for a repository</a>
 80  
      */
 81  
     @NotNull(message = "iterable is never NULL")
 82  
     Iterable<Milestone> iterate(
 83  
         @NotNull(message = "map of params can't be NULL")
 84  
         Map<String, String> params);
 85  
 
 86  
     /**
 87  
      * Remove milestone by number.
 88  
      * @param number Milestone number
 89  
      * @throws IOException If there is any I/O problem
 90  
      * @see <a href="http://developer.github.com/v3/issues/milestones/#delete-a-milestone">Delete a milestone</a>
 91  
      */
 92  
     void remove(@NotNull(message = "int can never be NULL") int number)
 93  
         throws IOException;
 94  
 }