com.jcabi.github

Class User.Smart

java.lang.Object

com.jcabi.github.User.Smart

All Implemented Interfaces:

JsonPatchable, JsonReadable, User

Enclosing interface:

User

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

Smart user with extra features.

See Also:

Get a Single User

To do:

#1:30min Implement methods to retrieve all values provided by Github for a single user, see: http://developer.github.com/v3/users/#get-a-single-user At the moment we implement just a few, but every data items should have its own method. Of course, every new item should be tested by a new unit test method.

Nested Class Summary

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

User.Smart

Constructor Summary

Constructors

Constructor and Description
User.Smart(User usr) Public ctor.

Method Summary

Methods

Modifier and Type	Method and Description
URL	avatarUrl() Get his avatar URL.
String	bio() Returns the value of bio property of User's JSON.
String	blog() Returns the value of blog property of User's JSON.
String	company() Get his company.
Github.Time	created() Returns the value of created_at property of User's JSON.
String	email() Get his email.
UserEmails	emails() Get user's emails.
String	eventsUrl() Returns the value of events_url property of User's JSON.
int	followersCount() Returns the value of followers property of User's JSON.
int	followingCount() Returns the value of following property of User's JSON.
String	followingUrl() Returns the value of following_url property of User's JSON.
String	follwersUrl() Returns the value of followers_url property of User's JSON.
String	gistsUrl() Returns the value of gists_url property of User's JSON.
Github	github() Github we're in.
String	gravatar() Returns the value of gravatar_id property of User's JSON.
boolean	hasName() Check if user has name.
boolean	hireable() Returns the value of hireable property of User's JSON.
String	htmlUrl() Returns the value of html_url property of User's JSON.
int	id() Get his ID.
javax.json.JsonObject	json() Describe it in a JSON object.
PublicKeys	keys() Get his keys.
String	location() Get his location.
String	login() Get his login.
String	name() Get his name.
Organizations	organizations() Get his organizations.
String	organizationsUrl() Returns the value of organizations_url property of User's JSON.
void	patch(javax.json.JsonObject json) Patch using this JSON object.
int	publicGists() Returns the value of public_gists property of User's JSON.
int	publicRepos() Returns the value of public_repos property of User's JSON.
String	receivedEventsUrl() Returns the value of received_events_url property of User's JSON.
String	reposUrl() Returns the value of repos_url property of User's JSON.
boolean	siteAdmin() Returns the value of site_admin property of User's JSON.
String	starredUrl() Returns the value of starred_url property of User's JSON.
String	subscriptionsUrl() Returns the value of subscriptions_url property of User's JSON.
String	type() Returns the value of type property of User's JSON.
Github.Time	updated() Returns the value of updated_at property of User's JSON.
URL	url() Get his URL.

Methods inherited from class java.lang.Object

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

Constructor Detail

User.Smart

public User.Smart(@NotNull(message="user can\'t be NULL")
          User usr)

Public ctor.

Parameters:

usr - User

Method Detail

id

public int id()
       throws IOException

Get his ID.

Returns:

Unique user ID

Throws:

IOException - If it fails

Suppressed Checkstyle violations:

MethodName (3 lines)

avatarUrl

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

Get his avatar URL.

Returns:

URL of the avatar

Throws:

IOException - If it fails

url

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

Get his URL.

Returns:

URL of the user

Throws:

IOException - If it fails

name

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

Get his name.

Returns:

User name

Throws:

IOException - If it fails

hasName

public boolean hasName()
                throws IOException

Check if user has name.

Returns:

True if user has name

Throws:

IOException - If it fails

company

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

Get his company.

Returns:

Company name

Throws:

IOException - If it fails

location

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

Get his location.

Returns:

Location name

Throws:

IOException - If it fails

email

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

Get his email.

Returns:

Email

Throws:

IOException - If it fails

github

@NotNull(message="Github is never NULL")
public Github github()

Description copied from interface: User

Github we're in.

Specified by:

github in interface User

Returns:

Github

login

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

Description copied from interface: User

Get his login.

Specified by:

login in interface User

Returns:

Login name

Throws:

IOException - If it fails

organizations

@NotNull(message="Organizations is never NULL")
public Organizations organizations()

Description copied from interface: User

Get his organizations.

Specified by:

organizations in interface User

Returns:

Organizations organizations

keys

@NotNull(message="Keys is never NULL")
public PublicKeys keys()

Description copied from interface: User

Get his keys.

Specified by:

keys in interface User

Returns:

PublicKeys keys

emails

@NotNull(message="Emails is never NULL")
public UserEmails emails()

Description copied from interface: User

Get user's emails.

Specified by:

emails in interface User

Returns:

User's emails

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

gravatar

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

Returns the value of gravatar_id property of User's JSON.

Returns:

The 'gravatar_id' property value.

Throws:

IOException - If any I/O error occurs.

htmlUrl

@NotNull(message="Html URL is never NULL")
public String htmlUrl()
               throws IOException

Returns the value of html_url property of User's JSON.

Returns:

The 'html_url' property value.

Throws:

IOException - If any I/O error occurs.

follwersUrl

@NotNull(message="Followers URL is never NULL")
public String follwersUrl()
                   throws IOException

Returns the value of followers_url property of User's JSON.

Returns:

The 'followers_url' property value.

Throws:

IOException - If any I/O error occurs.

followingUrl

@NotNull(message="Following URL is never NULL")
public String followingUrl()
                    throws IOException

Returns the value of following_url property of User's JSON.

Returns:

The 'following_url' property value.

Throws:

IOException - If any I/O error occurs.

gistsUrl

@NotNull(message="Gists URL is never NULL")
public String gistsUrl()
                throws IOException

Returns the value of gists_url property of User's JSON.

Returns:

The 'gists_url' property value.

Throws:

IOException - If any I/O error occurs.

starredUrl

@NotNull(message="Starred URL is never NULL")
public String starredUrl()
                  throws IOException

Returns the value of starred_url property of User's JSON.

Returns:

The 'starred_url' property value.

Throws:

IOException - If any I/O error occurs.

subscriptionsUrl

@NotNull(message="Subscriptions URL is never NULL")
public String subscriptionsUrl()
                        throws IOException

Returns the value of subscriptions_url property of User's JSON.

Returns:

The 'subscriptions_url' property value.

Throws:

IOException - If any I/O error occurs.

organizationsUrl

@NotNull(message="Organizations URL is never NULL")
public String organizationsUrl()
                        throws IOException

Returns the value of organizations_url property of User's JSON.

Returns:

The 'organizations_url' property value.

Throws:

IOException - If any I/O error occurs.

reposUrl

@NotNull(message="Repos URL is never NULL")
public String reposUrl()
                throws IOException

Returns the value of repos_url property of User's JSON.

Returns:

The 'repos_url' property value.

Throws:

IOException - If any I/O error occurs.

eventsUrl

@NotNull(message="Events URL is never NULL")
public String eventsUrl()
                 throws IOException

Returns the value of events_url property of User's JSON.

Returns:

The 'events_url' property value.

Throws:

IOException - If any I/O error occurs.

receivedEventsUrl

@NotNull(message="Received enets URL is never NULL")
public String receivedEventsUrl()
                         throws IOException

Returns the value of received_events_url property of User's JSON.

Returns:

The 'received_events_url' property value.

Throws:

IOException - If any I/O error occurs.

type

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

Returns the value of type property of User's JSON.

Returns:

The 'type' property value.

Throws:

IOException - If any I/O error occurs.

siteAdmin

public boolean siteAdmin()
                  throws IOException

Returns the value of site_admin property of User's JSON.

Returns:

The 'site_admin' property value.

Throws:

IOException - If any I/O error occurs.

blog

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

Returns the value of blog property of User's JSON.

Returns:

The 'blog' property value.

Throws:

IOException - If any I/O error occurs.

hireable

@NotNull(message="Hireable is never NULL")
public boolean hireable()
                 throws IOException

Returns the value of hireable property of User's JSON.

Returns:

The 'hireable' property value.

Throws:

IOException - If any I/O error occurs.

bio

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

Returns the value of bio property of User's JSON.

Returns:

The 'bio' property value.

Throws:

IOException - If any I/O error occurs.

publicRepos

public int publicRepos()
                throws IOException

Returns the value of public_repos property of User's JSON.

Returns:

The 'public_repos' property value.

Throws:

IOException - If any I/O error occurs.

publicGists

public int publicGists()
                throws IOException

Returns the value of public_gists property of User's JSON.

Returns:

The 'public_gists' property value.

Throws:

IOException - If any I/O error occurs.

followersCount

public int followersCount()
                   throws IOException

Returns the value of followers property of User's JSON.

Returns:

The 'followers' property value.

Throws:

IOException - If any I/O error occurs.

followingCount

public int followingCount()
                   throws IOException

Returns the value of following property of User's JSON.

Returns:

The 'following' property value.

Throws:

IOException - If any I/O error occurs.

created

@NotNull(message="Created time is never NULL")
public Github.Time created()
                    throws IOException

Returns the value of created_at property of User's JSON.

Returns:

The 'created_at' property value.

Throws:

IOException - If any I/O error occurs.

updated

@NotNull(message="Updated time is never NULL")
public Github.Time updated()
                    throws IOException

Returns the value of updated_at property of User's JSON.

Returns:

The 'updated_at' property value.

Throws:

IOException - If any I/O error occurs.