com.jcabi.github.Gist Maven / Gradle / Ivy
/**
* Copyright (c) 2013-2014, 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.util.ArrayList;
import java.util.Collection;
import javax.json.JsonObject;
import javax.json.JsonValue;
import javax.validation.constraints.NotNull;
import lombok.EqualsAndHashCode;
import lombok.ToString;
/**
* Github gist.
*
* @author Yegor Bugayenko ([email protected])
* @version $Id$
* @since 0.1
* @see Gists API
*/
@Immutable
@SuppressWarnings("PMD.TooManyMethods")
public interface Gist extends JsonReadable, JsonPatchable {
/**
* Github we're in.
* @return Github
*/
@NotNull(message = "Github is never NULL")
Github github();
/**
* Get gist identifier.
* @return Gist identifier
*/
@NotNull(message = "Identifier is never NULL")
String identifier();
/**
* Read file content.
* @param name Name of it
* @return File content
* @throws IOException If there is any I/O problem
* @see Get a Single Gist
*/
@NotNull(message = "file content is never NULL")
String read(@NotNull(message = "file name can't be NULL") String name)
throws IOException;
/**
* Write file content.
* @param name Name of it
* @param content Content to write
* @throws IOException If there is any I/O problem
* @see Edit a Gist
*/
void write(
@NotNull(message = "file name can't be NULL") String name,
@NotNull(message = "file content can't be NULL") String content)
throws IOException;
/**
* Star a gist.
* @throws IOException If there is any I/O problem
*/
void star() throws IOException;
/**
* Unstar a gist.
* @throws IOException If there is any I/O problem
*/
void unstar() throws IOException;
/**
* Checks if Gist is starred.
* @throws IOException If there is any I/O problem
* @return True if gist is starred
*/
boolean starred() throws IOException;
/**
* Fork the gist.
* @return Forked gist
* @throws IOException If there is any I/O problem
*/
@NotNull(message = "gist is never NULL")
Gist fork() throws IOException;
/**
* Get all comments of the gist.
* @return GistComments
* @throws IOException If there is any I/O problem
* @see Gist Comments API
*/
@NotNull(message = "comments are never NULL")
GistComments comments() throws IOException;
/**
* Smart Gist with extra features.
*/
@Immutable
@ToString
@Loggable(Loggable.DEBUG)
@EqualsAndHashCode(of = "gist")
final class Smart implements Gist {
/**
* Encapsulated gist.
*/
private final transient Gist gist;
/**
* Public ctor.
* @param gst Gist
*/
public Smart(@NotNull(message = "gst can't be NULL") final Gist gst) {
this.gist = gst;
}
/**
* Get gist id.
* @return Gist id
*/
@Override
@NotNull(message = "identifier is never NULL")
public String identifier() {
return this.gist.identifier();
}
/**
* Get a list of all file names in the gist.
* @return File names
* @throws IOException If there is any I/O problem
*/
@NotNull(message = "Iterable of files is never NULL")
public Iterable files() throws IOException {
final JsonObject array = this.gist.json().getJsonObject("files");
final Collection files =
new ArrayList(array.size());
for (final JsonValue value : array.values()) {
files.add(JsonObject.class.cast(value).getString("filename"));
}
return files;
}
@Override
@NotNull(message = "Github is never NULL")
public Github github() {
return this.gist.github();
}
@Override
@NotNull(message = "read is never NULL")
public String read(
@NotNull(message = "name can't be NULL") final String name
) throws IOException {
return this.gist.read(name);
}
@Override
public void write(
@NotNull(message = "name can't be NULL") final String name,
@NotNull(message = "content can't be NULL") final String content
) throws IOException {
this.gist.write(name, content);
}
@Override
public void star() throws IOException {
this.gist.star();
}
@Override
public void unstar() throws IOException {
this.gist.unstar();
}
@Override
public boolean starred() throws IOException {
return this.gist.starred();
}
@Override
@NotNull(message = "fork is never NULL")
public Gist fork() throws IOException {
return this.gist.fork();
}
@Override
@NotNull(message = "gist comments is never NULL")
public GistComments comments() throws IOException {
return this.gist.comments();
}
@Override
@NotNull(message = "JSON is never NULL")
public JsonObject json() throws IOException {
return this.gist.json();
}
@Override
public void patch(
@NotNull(message = "json can't be NULL") final JsonObject json
) throws IOException {
this.gist.patch(json);
}
}
}