com.jcabi.github

Class DeployKey.Smart

java.lang.Object

com.jcabi.github.DeployKey.Smart

All Implemented Interfaces:

DeployKey, JsonPatchable, JsonReadable

Enclosing interface:

DeployKey

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

Smart DeployKey with extra features.

Suppressed Checkstyle violations:

MultipleStringLiterals (500 lines)

Nested Class Summary

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

DeployKey.Smart

Constructor Summary

Constructors

Constructor and Description
DeployKey.Smart(DeployKey dkey) Public ctor.

Method Summary

Methods

Modifier and Type	Method and Description
javax.json.JsonObject	json() Describe it in a JSON object.
String	key() Get its key value.
void	key(String value) Change its value.
int	number() Get id of a deploy key.
void	patch(javax.json.JsonObject json) Patch using this JSON object.
void	remove() Delete a deploy key.
String	title() Get its title.
void	title(String text) Change its title.
URL	url() Get its URL.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeployKey.Smart

public DeployKey.Smart(@NotNull(message="deploy key is never NULL")
               DeployKey dkey)

Public ctor.

Parameters:

dkey - Deploy key

Method Detail

key

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

Get its key value.

Returns:

Value of deploy key

Throws:

IOException - If there is any I/O problem

key

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

Change its value.

Parameters:

value - Title of deploy key

Throws:

IOException - If there is any I/O problem

url

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

Get its URL.

Returns:

URL of deploy key

Throws:

IOException - If there is any I/O problem

title

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

Get its title.

Returns:

Title of deploy key

Throws:

IOException - If there is any I/O problem

title

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

Change its title.

Parameters:

text - Title of deploy key

Throws:

IOException - If there is any I/O problem

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 is never 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

number

public int number()

Description copied from interface: DeployKey

Get id of a deploy key.

Specified by:

number in interface DeployKey

Returns:

Id

remove

public void remove()
            throws IOException

Description copied from interface: DeployKey

Delete a deploy key.

Specified by:

remove in interface DeployKey

Throws:

IOException - If there is any I/O problem

See Also:

Remove a deploy key