Coverage Report - com.jcabi.github.PublicKeys
 
Classes in this File Line Coverage Branch Coverage Complexity
PublicKeys
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 javax.validation.constraints.NotNull;
 35  
 
 36  
 /**
 37  
  * Github public keys.
 38  
  *
 39  
  * @author Carlos Miranda (miranda.cma@gmail.com)
 40  
  * @version $Id$
 41  
  * @see <a href="http://developer.github.com/v3/users/keys/">Public Keys API</a>
 42  
  */
 43  
 @Immutable
 44  
 public interface PublicKeys {
 45  
 
 46  
     /**
 47  
      * User we're in.
 48  
      *
 49  
      * @return User
 50  
      */
 51  
     @NotNull(message = "user is never NULL")
 52  
     User user();
 53  
 
 54  
     /**
 55  
      * Iterate all public keys.
 56  
      *
 57  
      * @return All public keys.
 58  
      * @see <a href="http://developer.github.com/v3/users/keys#list-your-public-keys/">List your public keys.</a>
 59  
      */
 60  
     @NotNull(message = "Iterable of public keys is never NULL")
 61  
     Iterable<PublicKey> iterate();
 62  
 
 63  
     /**
 64  
      * Get a single public key.
 65  
      *
 66  
      * @param number ID of the public key to remove.
 67  
      * @return A single public key.
 68  
      * @see <a href="http://developer.github.com/v3/users/keys#get-a-single-public-key/">Get a single public key.</a>
 69  
      */
 70  
     @NotNull(message = "PublicKey is never NULL")
 71  
     PublicKey get(int number);
 72  
 
 73  
     /**
 74  
      * Create a public key.
 75  
      *
 76  
      * @param title The title of this key.
 77  
      * @param key The value of this key.
 78  
      * @return A new PublicKey
 79  
      * @throws IOException If an IO problem occurs.
 80  
      * @see <a href="http://developer.github.com/v3/users/keys/#create-a-public-key/">Create a public key.</a>
 81  
      */
 82  
     @NotNull(message = "PublicKey is never NULL")
 83  
     PublicKey create(
 84  
         @NotNull(message = "title is never NULL") String title,
 85  
         @NotNull(message = "key is never NULL") String key
 86  
     ) throws IOException;
 87  
 
 88  
     /**
 89  
      * Remove a public key.
 90  
      *
 91  
      * @param number ID of the public key to remove.
 92  
      * @throws IOException If an IO problem occurs.
 93  
      * @see <a href="http://developer.github.com/v3/users/keys/#delete-a-public-key/">Delete a public key.</a>
 94  
      */
 95  
     void remove(int number) throws IOException;
 96  
 
 97  
 }