org.springframework.social.connect

Class UserProfileBuilder

java.lang.Object

org.springframework.social.connect.UserProfileBuilder

public class UserProfileBuilder
extends Object

Builder for constructing a UserProfile instance returned by ApiAdapter.fetchUserProfile(Object) Makes it easy to construct a profile instance where some of the individual fields may be null. Also allows new profile fields to be introduced in the future without breaking compatibility with existing ApiAdapter implementations.

See Also:

UserProfile

Constructor Summary

Constructors

Constructor and Description
UserProfileBuilder()

Method Summary

Modifier and Type	Method and Description
UserProfile	build() Builds the user profile.
UserProfileBuilder	setEmail(String email) Sets the profile email field.
UserProfileBuilder	setFirstName(String firstName) Sets the profile firstName field.
UserProfileBuilder	setId(String id) Sets the profile id field.
UserProfileBuilder	setLastName(String lastName) Sets the profile lastName field.
UserProfileBuilder	setName(String name) Sets the profile name field.
UserProfileBuilder	setUsername(String username) Sets the profile username field.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserProfileBuilder

public UserProfileBuilder()

Method Detail

setId

public UserProfileBuilder setId(String id)

Sets the profile id field.

Parameters:

id - the user's id in the provider

Returns:

this UserProfileBuilder for setting more properties

setName

public UserProfileBuilder setName(String name)

Sets the profile name field. Note: parses the name string and sets the individual firstName and lastName fields as well.

Parameters:

name - the user's name

Returns:

this UserProfileBuilder for setting more properties

setFirstName

public UserProfileBuilder setFirstName(String firstName)

Sets the profile firstName field.

Parameters:

firstName - the user's first name

Returns:

this UserProfileBuilder for setting more properties

setLastName

public UserProfileBuilder setLastName(String lastName)

Sets the profile lastName field.

Parameters:

lastName - the user's last name

Returns:

this UserProfileBuilder for setting more properties

setEmail

public UserProfileBuilder setEmail(String email)

Sets the profile email field.

Parameters:

email - the user's email address

Returns:

this UserProfileBuilder for setting more properties

setUsername

public UserProfileBuilder setUsername(String username)

Sets the profile username field.

Parameters:

username - the user's username

Returns:

this UserProfileBuilder for setting more properties

build

public UserProfile build()

Builds the user profile. Call this method after setting all profile field values.

Returns:

the UserProfile