Package io.thestencil.persistence.api

Class ImmutableSiteState.Builder

java.lang.Object

io.thestencil.persistence.api.ImmutableSiteState.Builder

Enclosing class:

ImmutableSiteState

@NotThreadSafe
public static final class ImmutableSiteState.Builder
extends Object

Builds instances of type ImmutableSiteState. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Method Summary

Modifier and Type	Method	Description
ImmutableSiteState.Builder	articles(Map<String,? extends ZoePersistence.Entity<ZoePersistence.Article>> entries)	Sets or replaces all mappings from the specified map as entries for the articles map.
ImmutableSiteState	build()	Builds a new ImmutableSiteState.
ImmutableSiteState.Builder	contentType(ZoePersistence.SiteContentType contentType)	Initializes the value for the contentType attribute.
ImmutableSiteState.Builder	from(ZoePersistence.SiteState instance)	Fill a builder with attribute values from the provided SiteState instance.
ImmutableSiteState.Builder	links(Map<String,? extends ZoePersistence.Entity<ZoePersistence.Link>> entries)	Sets or replaces all mappings from the specified map as entries for the links map.
ImmutableSiteState.Builder	locales(Map<String,? extends ZoePersistence.Entity<ZoePersistence.Locale>> entries)	Sets or replaces all mappings from the specified map as entries for the locales map.
ImmutableSiteState.Builder	name(String name)	Initializes the value for the name attribute.
ImmutableSiteState.Builder	pages(Map<String,? extends ZoePersistence.Entity<ZoePersistence.Page>> entries)	Sets or replaces all mappings from the specified map as entries for the pages map.
ImmutableSiteState.Builder	putAllArticles(Map<String,? extends ZoePersistence.Entity<ZoePersistence.Article>> entries)	Put all mappings from the specified map as entries to articles map.
ImmutableSiteState.Builder	putAllLinks(Map<String,? extends ZoePersistence.Entity<ZoePersistence.Link>> entries)	Put all mappings from the specified map as entries to links map.
ImmutableSiteState.Builder	putAllLocales(Map<String,? extends ZoePersistence.Entity<ZoePersistence.Locale>> entries)	Put all mappings from the specified map as entries to locales map.
ImmutableSiteState.Builder	putAllPages(Map<String,? extends ZoePersistence.Entity<ZoePersistence.Page>> entries)	Put all mappings from the specified map as entries to pages map.
ImmutableSiteState.Builder	putAllReleases(Map<String,? extends ZoePersistence.Entity<ZoePersistence.Release>> entries)	Put all mappings from the specified map as entries to releases map.
ImmutableSiteState.Builder	putAllWorkflows(Map<String,? extends ZoePersistence.Entity<ZoePersistence.Workflow>> entries)	Put all mappings from the specified map as entries to workflows map.
ImmutableSiteState.Builder	putArticles(String key, ZoePersistence.Entity<ZoePersistence.Article> value)	Put one entry to the articles map.
ImmutableSiteState.Builder	putArticles(Map.Entry<String,? extends ZoePersistence.Entity<ZoePersistence.Article>> entry)	Put one entry to the articles map.
ImmutableSiteState.Builder	putLinks(String key, ZoePersistence.Entity<ZoePersistence.Link> value)	Put one entry to the links map.
ImmutableSiteState.Builder	putLinks(Map.Entry<String,? extends ZoePersistence.Entity<ZoePersistence.Link>> entry)	Put one entry to the links map.
ImmutableSiteState.Builder	putLocales(String key, ZoePersistence.Entity<ZoePersistence.Locale> value)	Put one entry to the locales map.
ImmutableSiteState.Builder	putLocales(Map.Entry<String,? extends ZoePersistence.Entity<ZoePersistence.Locale>> entry)	Put one entry to the locales map.
ImmutableSiteState.Builder	putPages(String key, ZoePersistence.Entity<ZoePersistence.Page> value)	Put one entry to the pages map.
ImmutableSiteState.Builder	putPages(Map.Entry<String,? extends ZoePersistence.Entity<ZoePersistence.Page>> entry)	Put one entry to the pages map.
ImmutableSiteState.Builder	putReleases(String key, ZoePersistence.Entity<ZoePersistence.Release> value)	Put one entry to the releases map.
ImmutableSiteState.Builder	putReleases(Map.Entry<String,? extends ZoePersistence.Entity<ZoePersistence.Release>> entry)	Put one entry to the releases map.
ImmutableSiteState.Builder	putWorkflows(String key, ZoePersistence.Entity<ZoePersistence.Workflow> value)	Put one entry to the workflows map.
ImmutableSiteState.Builder	putWorkflows(Map.Entry<String,? extends ZoePersistence.Entity<ZoePersistence.Workflow>> entry)	Put one entry to the workflows map.
ImmutableSiteState.Builder	releases(Map<String,? extends ZoePersistence.Entity<ZoePersistence.Release>> entries)	Sets or replaces all mappings from the specified map as entries for the releases map.
ImmutableSiteState.Builder	workflows(Map<String,? extends ZoePersistence.Entity<ZoePersistence.Workflow>> entries)	Sets or replaces all mappings from the specified map as entries for the workflows map.

Methods inherited from class java.lang.Object

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

Method Detail

from

@CanIgnoreReturnValue
public final ImmutableSiteState.Builder from(ZoePersistence.SiteState instance)

Fill a builder with attribute values from the provided SiteState 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

name

@CanIgnoreReturnValue
public final ImmutableSiteState.Builder name(String name)

Initializes the value for the name attribute.

Parameters:

name - The value for name

Returns:

this builder for use in a chained invocation

contentType

@CanIgnoreReturnValue
public final ImmutableSiteState.Builder contentType(ZoePersistence.SiteContentType contentType)

Initializes the value for the contentType attribute.

Parameters:

contentType - The value for contentType

Returns:

this builder for use in a chained invocation

putReleases

@CanIgnoreReturnValue
public final ImmutableSiteState.Builder putReleases(String key,
                                                    ZoePersistence.Entity<ZoePersistence.Release> value)

Put one entry to the releases map.

Parameters:

key - The key in the releases map

value - The associated value in the releases map

Returns:

this builder for use in a chained invocation

putReleases

@CanIgnoreReturnValue
public final ImmutableSiteState.Builder putReleases(Map.Entry<String,? extends ZoePersistence.Entity<ZoePersistence.Release>> entry)

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

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

releases

@CanIgnoreReturnValue
public final ImmutableSiteState.Builder releases(Map<String,? extends ZoePersistence.Entity<ZoePersistence.Release>> entries)

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

Parameters:

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

Returns:

this builder for use in a chained invocation

putAllReleases

@CanIgnoreReturnValue
public final ImmutableSiteState.Builder putAllReleases(Map<String,? extends ZoePersistence.Entity<ZoePersistence.Release>> entries)

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

Parameters:

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

Returns:

this builder for use in a chained invocation

putLocales

@CanIgnoreReturnValue
public final ImmutableSiteState.Builder putLocales(String key,
                                                   ZoePersistence.Entity<ZoePersistence.Locale> value)

Put one entry to the locales map.

Parameters:

key - The key in the locales map

value - The associated value in the locales map

Returns:

this builder for use in a chained invocation

putLocales

@CanIgnoreReturnValue
public final ImmutableSiteState.Builder putLocales(Map.Entry<String,? extends ZoePersistence.Entity<ZoePersistence.Locale>> entry)

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

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

locales

@CanIgnoreReturnValue
public final ImmutableSiteState.Builder locales(Map<String,? extends ZoePersistence.Entity<ZoePersistence.Locale>> entries)

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

Parameters:

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

Returns:

this builder for use in a chained invocation

putAllLocales

@CanIgnoreReturnValue
public final ImmutableSiteState.Builder putAllLocales(Map<String,? extends ZoePersistence.Entity<ZoePersistence.Locale>> entries)

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

Parameters:

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

Returns:

this builder for use in a chained invocation

putPages

@CanIgnoreReturnValue
public final ImmutableSiteState.Builder putPages(String key,
                                                 ZoePersistence.Entity<ZoePersistence.Page> value)

Put one entry to the pages map.

Parameters:

key - The key in the pages map

value - The associated value in the pages map

Returns:

this builder for use in a chained invocation

putPages

@CanIgnoreReturnValue
public final ImmutableSiteState.Builder putPages(Map.Entry<String,? extends ZoePersistence.Entity<ZoePersistence.Page>> entry)

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

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

pages

@CanIgnoreReturnValue
public final ImmutableSiteState.Builder pages(Map<String,? extends ZoePersistence.Entity<ZoePersistence.Page>> entries)

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

Parameters:

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

Returns:

this builder for use in a chained invocation

putAllPages

@CanIgnoreReturnValue
public final ImmutableSiteState.Builder putAllPages(Map<String,? extends ZoePersistence.Entity<ZoePersistence.Page>> entries)

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

Parameters:

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

Returns:

this builder for use in a chained invocation

putLinks

@CanIgnoreReturnValue
public final ImmutableSiteState.Builder putLinks(String key,
                                                 ZoePersistence.Entity<ZoePersistence.Link> value)

Put one entry to the links map.

Parameters:

key - The key in the links map

value - The associated value in the links map

Returns:

this builder for use in a chained invocation

putLinks

@CanIgnoreReturnValue
public final ImmutableSiteState.Builder putLinks(Map.Entry<String,? extends ZoePersistence.Entity<ZoePersistence.Link>> entry)

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

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

links

@CanIgnoreReturnValue
public final ImmutableSiteState.Builder links(Map<String,? extends ZoePersistence.Entity<ZoePersistence.Link>> entries)

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

Parameters:

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

Returns:

this builder for use in a chained invocation

putAllLinks

@CanIgnoreReturnValue
public final ImmutableSiteState.Builder putAllLinks(Map<String,? extends ZoePersistence.Entity<ZoePersistence.Link>> entries)

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

Parameters:

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

Returns:

this builder for use in a chained invocation

putArticles

@CanIgnoreReturnValue
public final ImmutableSiteState.Builder putArticles(String key,
                                                    ZoePersistence.Entity<ZoePersistence.Article> value)

Put one entry to the articles map.

Parameters:

key - The key in the articles map

value - The associated value in the articles map

Returns:

this builder for use in a chained invocation

putArticles

@CanIgnoreReturnValue
public final ImmutableSiteState.Builder putArticles(Map.Entry<String,? extends ZoePersistence.Entity<ZoePersistence.Article>> entry)

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

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

articles

@CanIgnoreReturnValue
public final ImmutableSiteState.Builder articles(Map<String,? extends ZoePersistence.Entity<ZoePersistence.Article>> entries)

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

Parameters:

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

Returns:

this builder for use in a chained invocation

putAllArticles

@CanIgnoreReturnValue
public final ImmutableSiteState.Builder putAllArticles(Map<String,? extends ZoePersistence.Entity<ZoePersistence.Article>> entries)

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

Parameters:

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

Returns:

this builder for use in a chained invocation

putWorkflows

@CanIgnoreReturnValue
public final ImmutableSiteState.Builder putWorkflows(String key,
                                                     ZoePersistence.Entity<ZoePersistence.Workflow> value)

Put one entry to the workflows map.

Parameters:

key - The key in the workflows map

value - The associated value in the workflows map

Returns:

this builder for use in a chained invocation

putWorkflows

@CanIgnoreReturnValue
public final ImmutableSiteState.Builder putWorkflows(Map.Entry<String,? extends ZoePersistence.Entity<ZoePersistence.Workflow>> entry)

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

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

workflows

@CanIgnoreReturnValue
public final ImmutableSiteState.Builder workflows(Map<String,? extends ZoePersistence.Entity<ZoePersistence.Workflow>> entries)

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

Parameters:

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

Returns:

this builder for use in a chained invocation

putAllWorkflows

@CanIgnoreReturnValue
public final ImmutableSiteState.Builder putAllWorkflows(Map<String,? extends ZoePersistence.Entity<ZoePersistence.Workflow>> entries)

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

Parameters:

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

Returns:

this builder for use in a chained invocation

build

public ImmutableSiteState build()

Builds a new ImmutableSiteState.

Returns:

An immutable instance of SiteState

Throws:

IllegalStateException - if any required attributes are missing