Coverage Report - com.jcabi.github.Hooks
 
Classes in this File Line Coverage Branch Coverage Complexity
Hooks
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 hooks.
 39  
  *
 40  
  * @author Paul Polishchuk (ppol@ua.fm)
 41  
  * @version $Id$
 42  
  * @since 0.8
 43  
  * @see <a href="http://developer.github.com/v3/repos/hooks/">Hooks API</a>
 44  
  */
 45  
 @Immutable
 46  
 public interface Hooks {
 47  
 
 48  
     /**
 49  
      * Owner of them.
 50  
      * @return Repo
 51  
      */
 52  
     @NotNull(message = "repository is never NULL")
 53  
     Repo repo();
 54  
 
 55  
     /**
 56  
      * Iterate them all.
 57  
      * @return Iterator of hooks
 58  
      * @see <a href="http://developer.github.com/v3/repos/hooks/#list">List</a>
 59  
      */
 60  
     @NotNull(message = "iterable is never NULL")
 61  
     Iterable<Hook> iterate();
 62  
 
 63  
     /**
 64  
      * Remove hook by ID.
 65  
      * @param number ID of the label to remove
 66  
      * @throws IOException If there is any I/O problem
 67  
      * @see <a href="http://developer.github.com/v3/repos/hooks/#delete-a-hook">List</a>
 68  
      */
 69  
     void remove(int number) throws IOException;
 70  
 
 71  
     /**
 72  
      * Get specific hook by number.
 73  
      * @param number Hook number
 74  
      * @return Hook
 75  
      * @see <a href="http://developer.github.com/v3/repos/hooks/#get-single-hook">Get single hook</a>
 76  
      */
 77  
     @NotNull(message = "hook is never NULL")
 78  
     Hook get(int number);
 79  
 
 80  
     /**
 81  
      * Create new hook.
 82  
      * @param name Hook name
 83  
      * @param config Configuration for the hook
 84  
      * @return Hook
 85  
      * @throws IOException If there is any I/O problem
 86  
      * @see <a href="http://developer.github.com/v3/repos/hooks/#create-a-hook">Create a hook</a>
 87  
      */
 88  
     @NotNull(message = "hook is never NULL")
 89  
     Hook create(
 90  
         @NotNull(message = "name is never NULL") String name,
 91  
         @NotNull(message = "config is never NULL") Map<String, String> config
 92  
     ) throws IOException;
 93  
 }