com.mikepenz.fastadapter.adapters

Class ModelAdapter<Model,Item extends IItem>

java.lang.Object

com.mikepenz.fastadapter.AbstractAdapter<Item>

com.mikepenz.fastadapter.adapters.ModelAdapter<Model,Item>

All Implemented Interfaces:

IAdapter<Item>, IItemAdapter<Model,Item>

Direct Known Subclasses:

ItemAdapter

public class ModelAdapter<Model,Item extends IItem>
extends AbstractAdapter<Item>
implements IItemAdapter<Model,Item>

Created by mikepenz on 27.12.15. A general ItemAdapter implementation based on the AbstractAdapter to speed up development for general items

Nested Class Summary

Nested classes/interfaces inherited from interface com.mikepenz.fastadapter.IItemAdapter

IItemAdapter.Predicate<Item extends IItem>

Field Summary

Fields inherited from class com.mikepenz.fastadapter.AbstractAdapter

mFastAdapter, mOrder

Constructor Summary

Constructors

Constructor and Description
ModelAdapter(IInterceptor<Model,Item> interceptor)
ModelAdapter(IItemList<Item> itemList, IInterceptor<Model,Item> interceptor)

Method Summary

Modifier and Type	Method and Description
ModelAdapter<Model,Item>	add(int position, java.util.List<Model> list) add a list of items at the given position within the existing items
ModelAdapter<Model,Item>	add(int position, Model... items) add an array of items at the given position within the existing items
ModelAdapter<Model,Item>	add(java.util.List<Model> list) add a list of items to the end of the existing items
ModelAdapter<Model,Item>	add(Model... items) add an array of items to the end of the existing items
ModelAdapter<Model,Item>	addInternal(int position, java.util.List<Item> items) add a list of items at the given position within the existing items
ModelAdapter<Model,Item>	addInternal(java.util.List<Item> items) add a list of items to the end of the existing items
ModelAdapter<Model,Item>	clear() removes all items of this adapter
void	filter(java.lang.CharSequence constraint) filters the items with the constraint using the provided Predicate
Item	getAdapterItem(int position)
int	getAdapterItemCount() defines the count of items of THIS adapter
java.util.List<Item>	getAdapterItems()
int	getAdapterPosition(Item item) Searches for the given item and calculates its relative position
int	getAdapterPosition(long identifier) Searches for the given identifier and calculates its relative position
int	getGlobalPosition(int position) returns the global position if the relative position within this adapter was given
IIdDistributor<Item>	getIdDistributor()
IInterceptor<Model,Item>	getInterceptor()
ItemFilter<Model,Item>	getItemFilter()
IItemList<Item>	getItemList()
java.util.List<Model>	getModels() the ModelAdapter does not keep a list of input model's to get retrieve them a `reverseInterceptor` is required usually it is used to get the `Model` from a `IModelItem`
IInterceptor<Item,Model>	getReverseInterceptor()
java.util.List<Item>	intercept(java.util.List<Model> models) Generates a List of Item based on it's List of Model using the interceptor
Item	intercept(Model model) Generates a `Item` based on it's `Model` using the interceptor
boolean	isUseIdDistributor()
static <Model,Item extends IItem> ModelAdapter<Model,Item>	models(IInterceptor<Model,Item> interceptor) static method to retrieve a new `ItemAdapter`
ModelAdapter<Model,Item>	move(int fromPosition, int toPosition) moves an item within the list from a position to a position
Triple<java.lang.Boolean,Item,java.lang.Integer>	recursive(AdapterPredicate<Item> predicate, boolean stopOnMatch) util function which recursively iterates over all items and subItems of the given adapter.
void	remapMappedTypes() forces to remap all possible types for the RecyclerView
ModelAdapter<Model,Item>	remove(int position) removes an item at the given position within the existing icons
ModelAdapter<Model,Item>	removeByIdentifier(long identifier) remvoes an item by it's identifier
ModelAdapter<Model,Item>	removeRange(int position, int itemCount) removes a range of items starting with the given position within the existing icons
ModelAdapter<Model,Item>	set(int position, Model element) sets an item at the given position, overwriting the previous item
ModelAdapter<Model,Item>	set(java.util.List<Model> items) set a new list of items and apply it to the existing list (clear - add) for this adapter NOTE may consider using setNewList if the items list is a reference to the list which is used inside the adapter
protected ModelAdapter<Model,Item>	set(java.util.List<Model> list, boolean resetFilter)
ModelAdapter<Model,Item>	set(java.util.List<Model> list, boolean resetFilter, IAdapterNotifier adapterNotifier) set a new list of model items and apply it to the existing list (clear - add) for this adapter NOTE may consider using setNewList if the items list is a reference to the list which is used inside the adapter
ModelAdapter<Model,Item>	setInternal(int position, Item item) sets an item at the given position, overwriting the previous item
ModelAdapter<Model,Item>	setInternal(java.util.List<Item> items, boolean resetFilter, IAdapterNotifier adapterNotifier) set a new list of model and apply it to the existing list (clear - add) for this adapter NOTE may consider using setNewList if the items list is a reference to the list which is used inside the adapter
ModelAdapter<Model,Item>	setNewList(java.util.List<Model> items) sets a complete new list of items onto this adapter, using the new list.
ModelAdapter<Model,Item>	setNewList(java.util.List<Model> list, boolean retainFilter) sets a complete new list of items onto this adapter, using the new list.
AbstractAdapter<Item>	withFastAdapter(FastAdapter<Item> fastAdapter) set the FastAdapter which will handle this AbstractAdapter
ModelAdapter<Model,Item>	withIdDistributor(IIdDistributor<Item> idDistributor) defines the idDistributor that is used to provide an ID to all added items
ModelAdapter<Model,Item>	withInterceptor(IInterceptor<Model,Item> mInterceptor)
ModelAdapter<Model,Item>	withItemFilter(ItemFilter<Model,Item> itemFilter) allows you to define your own Filter implementation instead of the default `ItemFilter`
ModelAdapter<Model,Item>	withReverseInterceptor(IInterceptor<Item,Model> reverseInterceptor)
ModelAdapter<Model,Item>	withUseIdDistributor(boolean useIdDistributor) defines if the DefaultIdDistributor is used to provide an ID to all added items which do not yet define an id

Methods inherited from class com.mikepenz.fastadapter.AbstractAdapter

getFastAdapter, getOrder, mapPossibleTypes, setOrder

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.mikepenz.fastadapter.IAdapter

getFastAdapter, getOrder, mapPossibleTypes, setOrder

Constructor Detail

ModelAdapter

public ModelAdapter(IInterceptor<Model,Item> interceptor)

ModelAdapter

public ModelAdapter(IItemList<Item> itemList,
                    IInterceptor<Model,Item> interceptor)

Method Detail

withFastAdapter

public AbstractAdapter<Item> withFastAdapter(FastAdapter<Item> fastAdapter)

Description copied from class: AbstractAdapter

set the FastAdapter which will handle this AbstractAdapter

Specified by:

withFastAdapter in interface IAdapter<Item extends IItem>

Overrides:

withFastAdapter in class AbstractAdapter<Item extends IItem>

getItemList

public IItemList<Item> getItemList()

Returns:

the `IItemList` implementation used by this `ModelAdapter`

models

public static <Model,Item extends IItem> ModelAdapter<Model,Item> models(IInterceptor<Model,Item> interceptor)

static method to retrieve a new `ItemAdapter`

Returns:

a new ItemAdapter

getInterceptor

public IInterceptor<Model,Item> getInterceptor()

withInterceptor

public ModelAdapter<Model,Item> withInterceptor(IInterceptor<Model,Item> mInterceptor)

getReverseInterceptor

public IInterceptor<Item,Model> getReverseInterceptor()

withReverseInterceptor

public ModelAdapter<Model,Item> withReverseInterceptor(IInterceptor<Item,Model> reverseInterceptor)

intercept

public Item intercept(Model model)

Generates a `Item` based on it's `Model` using the interceptor

Parameters:

model - the `Model` which will be used to create the `Item`

Returns:

the generated `Item`

intercept

public java.util.List<Item> intercept(java.util.List<Model> models)

Generates a List of Item based on it's List of Model using the interceptor

Parameters:

models - the List of Model which will be used to create the List of Item

Returns:

the generated List of Item

withIdDistributor

public ModelAdapter<Model,Item> withIdDistributor(IIdDistributor<Item> idDistributor)

defines the idDistributor that is used to provide an ID to all added items

Parameters:

idDistributor - the idDistributor to use

Returns:

this

getIdDistributor

public IIdDistributor<Item> getIdDistributor()

withUseIdDistributor

public ModelAdapter<Model,Item> withUseIdDistributor(boolean useIdDistributor)

defines if the DefaultIdDistributor is used to provide an ID to all added items which do not yet define an id

Parameters:

useIdDistributor - false if the DefaultIdDistributor shouldn't be used

Returns:

this

isUseIdDistributor

public boolean isUseIdDistributor()

Returns:

if we use the idDistributor with this adapter

withItemFilter

public ModelAdapter<Model,Item> withItemFilter(ItemFilter<Model,Item> itemFilter)

allows you to define your own Filter implementation instead of the default `ItemFilter`

Parameters:

itemFilter - the filter to use

Returns:

this

getItemFilter

public ItemFilter<Model,Item> getItemFilter()

Returns:

the filter used to filter items

filter

public void filter(java.lang.CharSequence constraint)

filters the items with the constraint using the provided Predicate

Parameters:

constraint - the string used to filter the list

getModels

public java.util.List<Model> getModels()

the ModelAdapter does not keep a list of input model's to get retrieve them a `reverseInterceptor` is required usually it is used to get the `Model` from a `IModelItem`

Returns:

a List of initial Model's

getAdapterItemCount

public int getAdapterItemCount()

Description copied from interface: IAdapter

defines the count of items of THIS adapter

Specified by:

getAdapterItemCount in interface IAdapter<Item extends IItem>

Returns:

the count of items within this adapter

getAdapterItems

public java.util.List<Item> getAdapterItems()

Specified by:

getAdapterItems in interface IAdapter<Item extends IItem>

Returns:

the items within this adapter

getAdapterPosition

public int getAdapterPosition(Item item)

Searches for the given item and calculates its relative position

Specified by:

getAdapterPosition in interface IAdapter<Item extends IItem>

Parameters:

item - the item which is searched for

Returns:

the relative position

getAdapterPosition

public int getAdapterPosition(long identifier)

Searches for the given identifier and calculates its relative position

Specified by:

getAdapterPosition in interface IAdapter<Item extends IItem>

Parameters:

identifier - the identifier of an item which is searched for

Returns:

the relative position

getGlobalPosition

public int getGlobalPosition(int position)

returns the global position if the relative position within this adapter was given

Specified by:

getGlobalPosition in interface IAdapter<Item extends IItem>

Parameters:

position - the relative position

Returns:

the global position

getAdapterItem

public Item getAdapterItem(int position)

Specified by:

getAdapterItem in interface IAdapter<Item extends IItem>

Parameters:

position - the relative position

Returns:

the item inside this adapter

set

public ModelAdapter<Model,Item> set(java.util.List<Model> items)

set a new list of items and apply it to the existing list (clear - add) for this adapter NOTE may consider using setNewList if the items list is a reference to the list which is used inside the adapter

Specified by:

set in interface IItemAdapter<Model,Item extends IItem>

Parameters:

items - the items to set

set

protected ModelAdapter<Model,Item> set(java.util.List<Model> list,
                                       boolean resetFilter)

set

public ModelAdapter<Model,Item> set(java.util.List<Model> list,
                                    boolean resetFilter,
                                    IAdapterNotifier adapterNotifier)

set a new list of model items and apply it to the existing list (clear - add) for this adapter NOTE may consider using setNewList if the items list is a reference to the list which is used inside the adapter

Parameters:

list - the items to set

resetFilter - `true` if the filter should get reset

adapterNotifier - a `IAdapterNotifier` allowing to modify the notify logic for the adapter (keep null for default)

Returns:

this

setInternal

public ModelAdapter<Model,Item> setInternal(java.util.List<Item> items,
                                            boolean resetFilter,
                                            IAdapterNotifier adapterNotifier)

set a new list of model and apply it to the existing list (clear - add) for this adapter NOTE may consider using setNewList if the items list is a reference to the list which is used inside the adapter

Parameters:

items - the items to set

resetFilter - `true` if the filter should get reset

adapterNotifier - a `IAdapterNotifier` allowing to modify the notify logic for the adapter (keep null for default)

Returns:

this

setNewList

public ModelAdapter<Model,Item> setNewList(java.util.List<Model> items)

sets a complete new list of items onto this adapter, using the new list. Calls notifyDataSetChanged

Specified by:

setNewList in interface IItemAdapter<Model,Item extends IItem>

Parameters:

items - the new items to set

setNewList

public ModelAdapter<Model,Item> setNewList(java.util.List<Model> list,
                                           boolean retainFilter)

sets a complete new list of items onto this adapter, using the new list. Calls notifyDataSetChanged

Parameters:

list - the new items to set

retainFilter - set to true if you want to keep the filter applied

Returns:

this

remapMappedTypes

public void remapMappedTypes()

forces to remap all possible types for the RecyclerView

add

@SafeVarargs
public final ModelAdapter<Model,Item> add(Model... items)

add an array of items to the end of the existing items

Specified by:

add in interface IItemAdapter<Model,Item extends IItem>

Parameters:

items - the items to add

add

public ModelAdapter<Model,Item> add(java.util.List<Model> list)

add a list of items to the end of the existing items

Specified by:

add in interface IItemAdapter<Model,Item extends IItem>

Parameters:

list - the items to add

addInternal

public ModelAdapter<Model,Item> addInternal(java.util.List<Item> items)

Description copied from interface: IItemAdapter

add a list of items to the end of the existing items

Specified by:

addInternal in interface IItemAdapter<Model,Item extends IItem>

add

@SafeVarargs
public final ModelAdapter<Model,Item> add(int position,
                                                       Model... items)

add an array of items at the given position within the existing items

Specified by:

add in interface IItemAdapter<Model,Item extends IItem>

Parameters:

position - the global position

items - the items to add

add

public ModelAdapter<Model,Item> add(int position,
                                    java.util.List<Model> list)

add a list of items at the given position within the existing items

Specified by:

add in interface IItemAdapter<Model,Item extends IItem>

Parameters:

position - the global position

list - the items to add

addInternal

public ModelAdapter<Model,Item> addInternal(int position,
                                            java.util.List<Item> items)

Description copied from interface: IItemAdapter

add a list of items at the given position within the existing items

Specified by:

addInternal in interface IItemAdapter<Model,Item extends IItem>

Parameters:

position - the global position

set

public ModelAdapter<Model,Item> set(int position,
                                    Model element)

sets an item at the given position, overwriting the previous item

Specified by:

set in interface IItemAdapter<Model,Item extends IItem>

Parameters:

position - the global position

element - the item to set

setInternal

public ModelAdapter<Model,Item> setInternal(int position,
                                            Item item)

Description copied from interface: IItemAdapter

sets an item at the given position, overwriting the previous item

Specified by:

setInternal in interface IItemAdapter<Model,Item extends IItem>

Parameters:

position - the global position

move

public ModelAdapter<Model,Item> move(int fromPosition,
                                     int toPosition)

moves an item within the list from a position to a position

Parameters:

fromPosition - the position global from which we want to move

toPosition - the global position to which to move

Returns:

this

remove

public ModelAdapter<Model,Item> remove(int position)

removes an item at the given position within the existing icons

Specified by:

remove in interface IItemAdapter<Model,Item extends IItem>

Parameters:

position - the global position

removeRange

public ModelAdapter<Model,Item> removeRange(int position,
                                            int itemCount)

removes a range of items starting with the given position within the existing icons

Specified by:

removeRange in interface IItemAdapter<Model,Item extends IItem>

Parameters:

position - the global position

itemCount - the count of items which were removed

clear

public ModelAdapter<Model,Item> clear()

removes all items of this adapter

Specified by:

clear in interface IItemAdapter<Model,Item extends IItem>

removeByIdentifier

public ModelAdapter<Model,Item> removeByIdentifier(long identifier)

remvoes an item by it's identifier

Parameters:

identifier - the identifier to search for

Returns:

this

recursive

public Triple<java.lang.Boolean,Item,java.lang.Integer> recursive(AdapterPredicate<Item> predicate,
                                                                  boolean stopOnMatch)

util function which recursively iterates over all items and subItems of the given adapter. It executes the given `predicate` on every item and will either stop if that function returns true, or continue (if stopOnMatch is false)

Parameters:

predicate - the predicate to run on every item, to check for a match or do some changes (e.g. select)

stopOnMatch - defines if we should stop iterating after the first match

Returns:

Triple<Boolean, IItem, Integer> The first value is true (it is always not null), the second contains the item and the third the position (if the item is visible) if we had a match, (always false and null and null in case of stopOnMatch == false)