com.jcabi.github

Interface Content

All Superinterfaces:

Comparable<Content>, JsonPatchable, JsonReadable

All Known Implementing Classes:

Content.Smart

@Immutable
public interface Content
extends Comparable<Content>, JsonReadable, JsonPatchable

Github content.

Since:

0.8

Version:

$Id$

Author:

Andres Candal (andres.candal@rollasolution.com)

See Also:

Contents API

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Content.Smart Smart Content with extra features.

Method Summary

Methods

Modifier and Type	Method and Description
String	path() Get its path name.
InputStream	raw() Get the raw contents.
Repo	repo() Repository we're in.

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.jcabi.github.JsonReadable

json

Methods inherited from interface com.jcabi.github.JsonPatchable

patch

Method Detail

repo

@NotNull(message="repository is never NULL")
Repo repo()

Repository we're in.

Returns:

Repo

path

@NotNull(message="path is never NULL")
String path()

Get its path name.

Returns:

The path name

raw

@NotNull(message="raw is never NULL")
InputStream raw()
                throws IOException

Get the raw contents.

Returns:

Input stream of the raw content

Throws:

IOException - If an IO error occurs