ch.rasc.piwik.tracking

Class PiwikRequest.Builder

java.lang.Object

ch.rasc.piwik.tracking.PiwikRequest.Builder

Enclosing interface:

PiwikRequest

public static final class PiwikRequest.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
PiwikRequest.Builder	addAllIdSite(Iterable<String> elements) Adds elements to idSite list.
PiwikRequest.Builder	addIdSite(String... elements) Adds elements to idSite list.
PiwikRequest.Builder	addIdSite(String element) Adds one element to idSite list.
ch.rasc.piwik.tracking.ImmutablePiwikRequest	build() Builds a new ImmutablePiwikRequest.
PiwikRequest.Builder	from(PiwikRequest instance) Fill a builder with attribute values from the provided PiwikRequest instance.
PiwikRequest.Builder	idSite(Iterable<String> elements) Sets or replaces all elements for idSite list.
PiwikRequest.Builder	parameters(Map<QueryParameter,? extends Object> parameters) Sets or replaces all mappings from the specified map as entries for the parameters map.
PiwikRequest.Builder	putAllParameters(Map<QueryParameter,? extends Object> parameters) Put all mappings from the specified map as entries to parameters map.
PiwikRequest.Builder	putParameter(Map.Entry<QueryParameter,? extends Object> entry) Put one entry to the parameters map.
PiwikRequest.Builder	putParameter(QueryParameter key, Object value) Put one entry to the parameters map.
PiwikRequest.Builder	url(String url) Initializes the value for the url attribute.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

from

public final PiwikRequest.Builder from(PiwikRequest instance)

Fill a builder with attribute values from the provided PiwikRequest instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values. Collection elements and entries will be added, not replaced.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

url

public final PiwikRequest.Builder url(String url)

Initializes the value for the url attribute.

Parameters:

url - The value for url

Returns:

this builder for use in a chained invocation

addIdSite

public final PiwikRequest.Builder addIdSite(String element)

Adds one element to idSite list.

Parameters:

element - A idSite element

Returns:

this builder for use in a chained invocation

addIdSite

public final PiwikRequest.Builder addIdSite(String... elements)

Adds elements to idSite list.

Parameters:

elements - An array of idSite elements

Returns:

this builder for use in a chained invocation

idSite

public final PiwikRequest.Builder idSite(Iterable<String> elements)

Sets or replaces all elements for idSite list.

Parameters:

elements - An iterable of idSite elements

Returns:

this builder for use in a chained invocation

addAllIdSite

public final PiwikRequest.Builder addAllIdSite(Iterable<String> elements)

Adds elements to idSite list.

Parameters:

elements - An iterable of idSite elements

Returns:

this builder for use in a chained invocation

putParameter

public final PiwikRequest.Builder putParameter(QueryParameter key,
                                               Object value)

Put one entry to the parameters map.

Parameters:

key - The key in the parameters map

value - The associated value in the parameters map

Returns:

this builder for use in a chained invocation

putParameter

public final PiwikRequest.Builder putParameter(Map.Entry<QueryParameter,? extends Object> entry)

Put one entry to the parameters map. Nulls are not permitted

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

parameters

public final PiwikRequest.Builder parameters(Map<QueryParameter,? extends Object> parameters)

Sets or replaces all mappings from the specified map as entries for the parameters map. Nulls are not permitted

Parameters:

parameters - The entries that will be added to the parameters map

Returns:

this builder for use in a chained invocation

putAllParameters

public final PiwikRequest.Builder putAllParameters(Map<QueryParameter,? extends Object> parameters)

Put all mappings from the specified map as entries to parameters map. Nulls are not permitted

Parameters:

parameters - The entries that will be added to the parameters map

Returns:

this builder for use in a chained invocation

build

public ch.rasc.piwik.tracking.ImmutablePiwikRequest build()

Builds a new ImmutablePiwikRequest.

Returns:

An immutable instance of PiwikRequest

Throws:

IllegalStateException - if any required attributes are missing