Coverage Report - com.jcabi.github.Reference
 
Classes in this File Line Coverage Branch Coverage Complexity
Reference
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.json.JsonObject;
 35  
 import javax.validation.constraints.NotNull;
 36  
 
 37  
 /**
 38  
  * Github Git Data Reference.
 39  
  *
 40  
  * @author Mihai Andronache (amihaiemil@gmail.com)
 41  
  * @version $Id$
 42  
  */
 43  
 @Immutable
 44  
 public interface Reference {
 45  
     /**
 46  
      * Return its owner repo.
 47  
      * @return Repo
 48  
      */
 49  
     @NotNull(message = "repository is never NULL")
 50  
     Repo repo();
 51  
 
 52  
     /**
 53  
      * Return its name.
 54  
      * @return String
 55  
      */
 56  
     @NotNull(message = "ref is never NULL")
 57  
     String ref();
 58  
 
 59  
     /**
 60  
      * Return its Json.
 61  
      * @return JsonObject
 62  
      * @throws IOException - If something goes wrong.
 63  
      */
 64  
     @NotNull(message = "JSON is never NULL")
 65  
     JsonObject json() throws IOException;
 66  
 
 67  
     /**
 68  
      * Patch using this JSON object.
 69  
      * @param json JSON object
 70  
      * @throws IOException If there is any I/O problem
 71  
      */
 72  
     void patch(@NotNull(message = "JSON is never null") JsonObject json)
 73  
         throws IOException;
 74  
 
 75  
 }