/**
    * Copyright (c) 2013-2023, jcabi.com
    * All rights reserved.
    *
    * Redistribution and use in source and binary forms, with or without
    * modification, are permitted provided that the following conditions
    * are met: 1) Redistributions of source code must retain the above
    * copyright notice, this list of conditions and the following
    * disclaimer. 2) Redistributions in binary form must reproduce the above
   * copyright notice, this list of conditions and the following
   * disclaimer in the documentation and/or other materials provided
   * with the distribution. 3) Neither the name of the jcabi.com nor
   * the names of its contributors may be used to endorse or promote
   * products derived from this software without specific prior written
   * permission.
   *
   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
   * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
   * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
   * THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
   * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
   * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
   * OF THE POSSIBILITY OF SUCH DAMAGE.
   */
  package com.jcabi.github;
  
  import com.jcabi.aspects.Immutable;
  import com.jcabi.aspects.Loggable;
  import java.io.IOException;
  import java.io.InputStream;
  import java.net.URL;
  import javax.json.JsonObject;
  import javax.xml.bind.DatatypeConverter;
  import lombok.EqualsAndHashCode;
  import lombok.ToString;
  
  /**
   * Github content.
   *
   * @author Andres Candal (andres.candal@rollasolution.com)
   * @version $Id: 5e32a2c66bba916faff87237b3734640691951ef $
   * @since 0.8
   * @see <a href="https://developer.github.com/v3/repos/contents/">Contents API</a>
   */
  @Immutable
  @SuppressWarnings("PMD.TooManyMethods")
  public interface Content extends Comparable<Content>,
      JsonReadable, JsonPatchable {
  
      /**
       * Repository we're in.
       * @return Repo
       */
      Repo repo();
  
      /**
       * Get its path name.
       * @return The path name
       */
      String path();
  
      /**
       * Get the raw contents.
       * @throws IOException If an IO error occurs
       * @return Input stream of the raw content
       */
      InputStream raw() throws IOException;
  
      /**
       * Smart Content with extra features.
       */
      @Immutable
      @ToString
      @Loggable(Loggable.DEBUG)
      @EqualsAndHashCode(of = { "content", "jsn" })
      final class Smart implements Content {
          /**
           * Encapsulated content.
           */
          private final transient Content content;
          /**
           * SmartJson object for convenient JSON parsing.
           */
          private final transient SmartJson jsn;
          /**
           * Public ctor.
           * @param cont Content
           */
          public Smart(
              final Content cont) {
              this.content = cont;
              this.jsn = new SmartJson(cont);
          }
          /**
          * Get its name.
          * @return Name of content
          * @throws IOException If there is any I/O problem
          */
         public String name() throws IOException {
             return this.jsn.text("name");
         }
         /**
          * Get its type.
          * @return Type of content
          * @throws IOException If there is any I/O problem
          */
         public String type() throws IOException {
             return this.jsn.text("type");
         }
         /**
          * Get its size.
          * @return Size content
          * @throws IOException If it fails
          */
         public int size() throws IOException {
             return this.jsn.number("size");
         }
         /**
          * Get its sha hash.
          * @return Sha hash of content
          * @throws IOException If there is any I/O problem
          */
         public String sha() throws IOException {
             return this.jsn.text("sha");
         }
         /**
          * Get its URL.
          * @return URL of content
          * @throws IOException If there is any I/O problem
          */
         public URL url() throws IOException {
             return new URL(this.jsn.text("url"));
         }
         /**
          * Get its HTML URL.
          * @return URL of content
          * @throws IOException If there is any I/O problem
          */
         public URL htmlUrl() throws IOException {
             return new URL(this.jsn.text("html_url"));
         }
         /**
          * Get its GIT URL.
          * @return URL of content
          * @throws IOException If there is any I/O problem
          */
         public URL gitUrl() throws IOException {
             return new URL(this.jsn.text("git_url"));
         }
         /**
          * Get its encoded content.
          * @return Base64 encoded content
          * @throws IOException If there is any I/O problem
          */
         public String content() throws IOException {
             return this.jsn.text("content");
         }
         /**
          * Get its decoded content.
          * @return Decoded content
          * @throws IOException If there is any I/O problem
          */
         public byte[] decoded() throws IOException {
             return DatatypeConverter.parseBase64Binary(this.content());
         }
         @Override
         public int compareTo(final Content cont) {
             return this.content.compareTo(cont);
         }
         @Override
         public void patch(final JsonObject json) throws IOException {
             this.content.patch(json);
         }
         @Override
         public JsonObject json() throws IOException {
             return this.content.json();
         }
         @Override
         public Repo repo() {
             return this.content.repo();
         }
         @Override
         public String path() {
             return this.content.path();
         }
         @Override
         public InputStream raw() throws IOException {
             return this.content.raw();
         }
     }
 }