com.foreach.across.modules.webcms.domain.component.model

Class WebCmsComponentModelSet

java.lang.Object

com.foreach.across.modules.webcms.domain.component.model.WebCmsComponentModelSet

public class WebCmsComponentModelSet
extends Object

Represents a lookup for WebCmsComponentModels that are accessible by name. All components in a single set are expected to be owned by the value #getOwner().

A set can have a fetcher function value (#setFetcherFunction(BiFunction)). This function will be used to retrieve a component if it is not yet present in the set. A component name will only ever be looked up once unless it is removed again.

Since:

0.0.2

Author:

Arne Vandamme

Constructor Summary

Constructors

Constructor and Description
WebCmsComponentModelSet()

Method Summary

Modifier and Type	Method and Description
void	add(WebCmsComponentModel componentModel) Add a component to the ordered list.
void	clear() Remove all components from this set.
boolean	contains(String name)
WebCmsComponentModel	get(String name) Gets the component with that name.
void	put(@NonNull String name, WebCmsComponentModel componentModel) Register a component under a specific name in the set.
WebCmsComponentModel	remove(String name) Removes the component registered with that name.
boolean	remove(@NonNull WebCmsComponentModel componentModel) Removes the component model.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebCmsComponentModelSet

public WebCmsComponentModelSet()

Method Detail

add

public void add(WebCmsComponentModel componentModel)

Add a component to the ordered list. If another component with that name exists, it will be replaced by name but will still be added to the ordered collection.

Parameters:

componentModel - to add

put

public void put(@NonNull
                @NonNull String name,
                WebCmsComponentModel componentModel)

Register a component under a specific name in the set. The actual value of WebCmsComponentModel.getName() will be ignored.

If the model is null, you are explicitly marking a component as unavailable. In case of a fetcher function it will not be looked up either.

Parameters:

name - to register the component under

componentModel - to add

contains

public boolean contains(String name)

Returns:

true if the set contains a component with that name

get

public WebCmsComponentModel get(String name)

Gets the component with that name. If a fetcherFunction has been specified, it will be used to retrieve the component if it is not yet present.

Returns:

component or null if not found

remove

public WebCmsComponentModel remove(String name)

Removes the component registered with that name. Note that if a fetcher function is set, the component will be fetched again. If you do not want this, set the component for that name explicitly to null.

Parameters:

name - of the component to remove

Returns:

component removed

remove

public boolean remove(@NonNull
                      @NonNull WebCmsComponentModel componentModel)

Removes the component model. If the same component model were to be registered under multiple names, all of them would be removed.

Parameters:

componentModel - to remove

Returns:

true if at least one entry has been removed

clear

public void clear()

Remove all components from this set. If a fetcher function was set, components will be looked up again.