Package com.github.ambry.account

Class AccountBuilder

java.lang.Object

com.github.ambry.account.AccountBuilder

public class AccountBuilder
extends java.lang.Object

A builder class for Account. Since Account is immutable, modifying an Account needs to build a new Account object with updated fields through this builder. An Account can be built in two ways: 1) from an existing Account object; and 2) by supplying required fields of an Account. This class is not thread safe.

Constructor Summary

Constructors

Constructor	Description
AccountBuilder(short id, java.lang.String name, Account.AccountStatus status)	Constructor.
AccountBuilder(Account origin)	Constructor.

Method Summary

Modifier and Type	Method	Description
AccountBuilder	addOrUpdateContainer(Container container)	Adds a Container for the Account to build.
Account	build()	Builds an Account object.
AccountBuilder	containers(java.util.Collection<Container> containers)	Clear the set of containers for the Account to build and add the provided ones.
AccountBuilder	id(short id)	Sets the id of the Account to build.
AccountBuilder	lastModifiedTime(long lastModifiedTime)	Sets the created/modified time of the Account to build.
AccountBuilder	name(java.lang.String name)	Sets the name of the Account to build.
AccountBuilder	removeContainer(Container container)	Removes a Container in this builder, so that an Account to build will not have this Container.
AccountBuilder	snapshotVersion(int snapshotVersion)	Sets the snapshot version of the Account to build.
AccountBuilder	status(Account.AccountStatus status)	Sets the status of the Account to build.

Methods inherited from class java.lang.Object

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

Constructor Detail

AccountBuilder

public AccountBuilder(Account origin)

Constructor. This will build a new Account from an existing Account object. The builder will include all the information including the Containers of the existing Account.

Parameters:

origin - The Account to build from.

AccountBuilder

public AccountBuilder(short id,
                      java.lang.String name,
                      Account.AccountStatus status)

Constructor. The builder will not include any Container information.

Parameters:

id - The id of the Account to build. Can be null, but should be set before calling build().

name - The name of the Account. Can be null, but should be set before calling build().

status - The status of the Account. Can be null, but should be set before calling build().

Method Detail

id

public AccountBuilder id(short id)

Sets the id of the Account to build.

Parameters:

id - The id to set.

Returns:

This builder.

name

public AccountBuilder name(java.lang.String name)

Sets the name of the Account to build.

Parameters:

name - The name to set.

Returns:

This builder.

status

public AccountBuilder status(Account.AccountStatus status)

Sets the status of the Account to build.

Parameters:

status - The id to set.

Returns:

This builder.

snapshotVersion

public AccountBuilder snapshotVersion(int snapshotVersion)

Sets the snapshot version of the Account to build.

Parameters:

snapshotVersion - The version to set.

Returns:

This builder.

lastModifiedTime

public AccountBuilder lastModifiedTime(long lastModifiedTime)

Sets the created/modified time of the Account to build.

Parameters:

lastModifiedTime - time in milliseconds.

Returns:

This builder.

containers

public AccountBuilder containers(java.util.Collection<Container> containers)

Clear the set of containers for the Account to build and add the provided ones.

Parameters:

containers - A collection of Containers to use. Can be null to just remove all containers.

Returns:

This builder.

addOrUpdateContainer

public AccountBuilder addOrUpdateContainer(Container container)

Adds a Container for the Account to build. If the builder already has a Container with the same id as new Container to set, the new Container will replace the existing Container.

Parameters:

container - The new Container to set.

Returns:

This builder.

removeContainer

public AccountBuilder removeContainer(Container container)

Removes a Container in this builder, so that an Account to build will not have this Container. It will be a no-op if no Container with the id exists in this builder.

Parameters:

container - The Container to remove.

Returns:

This builder.

build

public Account build()

Builds an Account object. id, name, status, lastModifiedTime and containers (if any) must be set before building.

Returns:

An Account object.

Throws:

java.lang.IllegalStateException - If any required fields is not set or there is inconsistency in containers.