universum.studios.android.officium.sync

Class SyncEvent.Builder

java.lang.Object

universum.studios.android.officium.sync.SyncEvent.Builder

Enclosing class:

SyncEvent

public static class SyncEvent.Builder
extends Object

Builder that can be used to create a new instance of SyncEvent.

Author:

Martin Albedinsky

Constructor Summary

Constructors

Constructor and Description
Builder(int id) Creates a new instance of Builder with the specified id.

Method Summary

Modifier and Type	Method and Description
SyncEvent.Builder	account(Account account) Specifies an account for which SyncEvent will be fired.
SyncEvent	build() Builds a new instance of SyncEvent.
SyncEvent.Builder	error(Exception error) Specifies an error that occurred during synchronization.
SyncEvent.Builder	extras(Bundle extras) Specifies a bundle with extra information for the event.
SyncEvent.Builder	progress(int progress) Specifies a progress of running synchronization.
SyncEvent.Builder	type(int type) Specifies a type of SyncEvent that will be fired.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(int id)

Creates a new instance of Builder with the specified id.

Parameters:

id - The desired id for the new SyncEvent.

See Also:

SyncEvent.id

Method Detail

type

public SyncEvent.Builder type(int type)

Specifies a type of SyncEvent that will be fired.

Parameters:

type - The desired type. May be one of SyncEvent.START, SyncEvent.PROGRESS, SyncEvent.FINISH or SyncEvent.ERROR or custom specified type.

Returns:

This builder to allow methods chaining.

See Also:

SyncEvent.type

progress

public SyncEvent.Builder progress(int progress)

Specifies a progress of running synchronization.

Parameters:

progress - The desired progress.

Returns:

This builder to allow methods chaining.

See Also:

SyncEvent.progress

error

public SyncEvent.Builder error(@NonNull
                               Exception error)

Specifies an error that occurred during synchronization.

Parameters:

error - The desired error.

Returns:

This builder to allow methods chaining.

See Also:

SyncEvent.error

account

public SyncEvent.Builder account(@NonNull
                                 Account account)

Specifies an account for which SyncEvent will be fired.

Parameters:

account - The desired account.

Returns:

This builder to allow methods chaining.

See Also:

SyncEvent.account

extras

public SyncEvent.Builder extras(@NonNull
                                Bundle extras)

Specifies a bundle with extra information for the event.

Parameters:

extras - The desired bundle with extras.

Returns:

This builder to allow methods chaining.

See Also:

SyncEvent.extras

build

@NonNull
public SyncEvent build()

Builds a new instance of SyncEvent.

Returns:

New instance of SyncEvent with data specified for this builder.