Coverage Report - com.jcabi.github.Gists
 
Classes in this File Line Coverage Branch Coverage Complexity
Gists
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 gists.
 39  
  *
 40  
  * @author Yegor Bugayenko (yegor@tpc2.com)
 41  
  * @version $Id$
 42  
  * @since 0.1
 43  
  * @see <a href="http://developer.github.com/v3/gists/">Gists API</a>
 44  
  */
 45  
 @Immutable
 46  
 public interface Gists {
 47  
 
 48  
     /**
 49  
      * Github we're in.
 50  
      * @return Github
 51  
      */
 52  
     @NotNull(message = "Github is never NULL")
 53  
     Github github();
 54  
 
 55  
     /**
 56  
      * Create a new gist.
 57  
      *
 58  
      * @param files Names and content of files
 59  
      * @param visible Indicates whether the gist is public
 60  
      * @return Gist
 61  
      * @throws IOException If there is any I/O problem
 62  
      * @see <a href="http://developer.github.com/v3/gists/#create-a-gist">Create a Gist</a>
 63  
      */
 64  
     @NotNull(message = "gist is never NULL")
 65  
     Gist create(@NotNull(message = "list of files can't be NULL")
 66  
         Map<String, String> files, boolean visible) throws IOException;
 67  
 
 68  
     /**
 69  
      * Get gist by name.
 70  
      * @param name Name of it
 71  
      * @return Gist
 72  
      * @see <a href="http://developer.github.com/v3/gists/#get-a-single-gist">Get a Single Gist</a>
 73  
      */
 74  
     @NotNull(message = "gist is never NULL")
 75  
     Gist get(@NotNull(message = "name can't be NULL") String name);
 76  
 
 77  
     /**
 78  
      * Iterate all gists.
 79  
      * @return Iterator of gists
 80  
      * @see <a href="http://developer.github.com/v3/gists/#list-gists">List Gists</a>
 81  
      */
 82  
     @NotNull(message = "iterable is never NULL")
 83  
     Iterable<Gist> iterate();
 84  
 
 85  
     /**
 86  
      * Removes a gist by id.
 87  
      *
 88  
      *
 89  
      * @param identifier Identifier of the gist to be removed.
 90  
      * @throws IOException If there is any I/O problem
 91  
      */
 92  
     void remove(
 93  
         @NotNull(message = "identifier is never NULL") String identifier
 94  
     ) throws IOException;
 95  
 }