com.jcabi.github

Class Release.Smart

java.lang.Object

com.jcabi.github.Release.Smart

All Implemented Interfaces:

JsonPatchable, JsonReadable, Release

Enclosing interface:

Release

@Immutable
@Loggable(value=1)
public static final class Release.Smart
extends Object
implements Release

Smart release.

Nested Class Summary

Nested classes/interfaces inherited from interface com.jcabi.github.Release

Release.Smart

Constructor Summary

Constructors

Constructor and Description
Release.Smart(Release original) Public CTOR.

Method Summary

Methods

Modifier and Type	Method and Description
ReleaseAssets	assets() Get all release assets of this release.
URL	assetsUrl() Get release assets url.
String	body() Get release body.
void	body(String text) Change its body.
String	commitish() Get release target commitish.
void	commitish(String text) Change its target commitish.
Date	createdAt() Get release creation date.
void	delete() Deletes a release.
boolean	draft() Is release draft.
void	draft(boolean draft) Change its status.
boolean	hasName() Does this release have a name?
URL	htmlUrl() Get release html url.
javax.json.JsonObject	json() Describe it in a JSON object.
String	name() Get release name.
void	name(String text) Change its name.
int	number() Release id.
void	patch(javax.json.JsonObject json) Patch using this JSON object.
boolean	prerelease() Is it prerelease.
void	prerelease(boolean pre) Change its prerelease.
Date	publishedAt() Get release publication date.
Repo	repo() Owner of them.
String	tag() Get release tag name.
void	tag(String text) Change its tag name.
URL	uploadUrl() Get release upload url.
URL	url() Get release url.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Release.Smart

public Release.Smart(@NotNull(message="original can\'t be NULL")
             Release original)

Public CTOR.

Parameters:

original - Original release

Method Detail

json

@NotNull(message="JSON is never NULL")
public javax.json.JsonObject json()
                           throws IOException

Description copied from interface: JsonReadable

Describe it in a JSON object.

Specified by:

json in interface JsonReadable

Returns:

JSON object

Throws:

IOException - If there is any I/O problem

patch

public void patch(@NotNull(message="json can\'t be NULL")
         javax.json.JsonObject json)
           throws IOException

Description copied from interface: JsonPatchable

Patch using this JSON object.

Specified by:

patch in interface JsonPatchable

Parameters:

json - JSON object

Throws:

IOException - If there is any I/O problem

repo

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

Description copied from interface: Release

Owner of them.

Specified by:

repo in interface Release

Returns:

Repo

number

public int number()

Description copied from interface: Release

Release id.

Specified by:

number in interface Release

Returns:

Id

assets

@NotNull(message="assets is never NULL")
public ReleaseAssets assets()

Description copied from interface: Release

Get all release assets of this release.

Specified by:

assets in interface Release

Returns:

Release assets.

See Also:

Releases API

url

@NotNull(message="URL cannot be NULL")
public URL url()
        throws IOException

Get release url.

Returns:

Release url

Throws:

IOException - If there is any I/O problem

htmlUrl

@NotNull(message="URL cannot possibly be NULL")
public URL htmlUrl()
            throws IOException

Get release html url.

Returns:

Release html url

Throws:

IOException - If there is any I/O problem

assetsUrl

@NotNull(message="URL isn\'t ever NULL")
public URL assetsUrl()
              throws IOException

Get release assets url.

Returns:

Release assets url

Throws:

IOException - If there is any I/O problem

uploadUrl

@NotNull(message="URL is never NULL")
public URL uploadUrl()
              throws IOException

Get release upload url.

Returns:

Release upload url

Throws:

IOException - If there is any I/O problem

tag

@NotNull(message="tag is never NULL")
public String tag()
           throws IOException

Get release tag name.

Returns:

The release tag name

Throws:

IOException - If there is any I/O problem

tag

public void tag(@NotNull(message="text cannot be NULL")
       String text)
         throws IOException

Change its tag name.

Parameters:

text - Tag name

Throws:

IOException - If there is any I/O problem

commitish

@NotNull(message="commitish can\'t be NULL")
public String commitish()
                 throws IOException

Get release target commitish.

Returns:

Release target commitish value

Throws:

IOException - If there is any I/O problem

commitish

public void commitish(@NotNull(message="text shouldn\'t be NULL")
             String text)
               throws IOException

Change its target commitish.

Parameters:

text - Target commitish.

Throws:

IOException - If there is any I/O problem

hasName

public boolean hasName()
                throws IOException

Does this release have a name?

Returns:

Whether this release has a name

Throws:

IOException - If there is any I/O problem

name

@NotNull(message="name is never NULL")
public String name()
            throws IOException

Get release name. Note that there may not be one, so make sure to check with hasName() first.

Returns:

Release name

Throws:

IOException - If there is any I/O problem

name

public void name(@NotNull(message="text should not be NULL")
        String text)
          throws IOException

Change its name.

Parameters:

text - Name of release.

Throws:

IOException - If there is any I/O problem

body

@NotNull(message="body is never NULL")
public String body()
            throws IOException

Get release body.

Returns:

Release body

Throws:

IOException - If there is any I/O problem

body

public void body(@NotNull(message="text can\'t be NULL")
        String text)
          throws IOException

Change its body.

Parameters:

text - Text describing the contents of the tag

Throws:

IOException - If there is any I/O problem

createdAt

@NotNull(message="date is never NULL")
public Date createdAt()
               throws IOException

Get release creation date.

Returns:

Release creation date

Throws:

IOException - If there is any I/O problem

publishedAt

@NotNull(message="date is never NULL")
public Date publishedAt()
                 throws IOException

Get release publication date.

Returns:

Release publication date

Throws:

IOException - If there is any I/O problem

draft

public boolean draft()
              throws IOException

Is release draft.

Returns:

Returns true if it's draft

Throws:

IOException - If there is any I/O problem

draft

public void draft(boolean draft)
           throws IOException

Change its status.

Parameters:

draft - True makes the release a draft.

Throws:

IOException - If there is any I/O problem

prerelease

public boolean prerelease()
                   throws IOException

Is it prerelease.

Returns:

Returns true if it's prerelease

Throws:

IOException - If there is any I/O problem

prerelease

public void prerelease(boolean pre)
                throws IOException

Change its prerelease.

Parameters:

pre - True to identify the release as a prerelease.

Throws:

IOException - If there is any I/O problem

delete

public void delete()
            throws IOException

Description copied from interface: Release

Deletes a release.

Specified by:

delete in interface Release

Throws:

IOException - If any I/O problems occur.