ItemBinding (bindingcollectionadapter 3.1.1 API)

java.lang.Object
- me.tatarka.bindingcollectionadapter2.ItemBinding<T>

Type Parameters:

T - The item type.
```
public final class ItemBinding<T>
extends java.lang.Object
```
Provides the necessary information to bind an item in a collection to a view. This includes the variable id and the layout as well as any extra bindings you may want to provide.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`VAR_NONE` Use this constant as the variable id to not bind the item in the collection to the layout if no data is need, like a static footer or loading indicator.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`bind(ViewDataBinding binding, T item)` Binds the item and extra bindings to the given binding.
`ItemBinding<T>`	`bindExtra(int variableId, java.lang.Object value)` Bind an extra variable to the view with the given variable id.
`ItemBinding<T>`	`clearExtras()` Clear all extra variables.
`java.lang.Object`	`extraBinding(int variableId)` Returns the current extra binding for the given variable id or null if one isn't present.
`int`	`layoutRes()` Returns the current layout fo this binding.
`ItemBinding<T>`	`layoutRes(int layoutRes)` Set the layout.
`static <T> ItemBinding<T>`	`of(int variableId, int layoutRes)` Constructs an instance with the given variable id and layout.
`static <T> ItemBinding<T>`	`of(OnItemBind<T> onItemBind)` Constructs an instance with the given callback.
`void`	`onItemBind(int position, T item)` Updates the state of the binding for the given item and position.
`ItemBinding<T>`	`removeExtra(int variableId)` Remove an extra variable with the given variable id.
`ItemBinding<T>`	`set(int variableId, int layoutRes)` Set the variable id and layout.
`int`	`variableId()` Returns the current variable id of this binding.
`ItemBinding<T>`	`variableId(int variableId)` Set the variable id.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - VAR_NONE
```
public static final int VAR_NONE
```
    Use this constant as the variable id to not bind the item in the collection to the layout if no data is need, like a static footer or loading indicator.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - of
```
public static <T> ItemBinding<T> of(int variableId,
                                    int layoutRes)
```
    Constructs an instance with the given variable id and layout.
  - of
```
public static <T> ItemBinding<T> of(OnItemBind<T> onItemBind)
```
    Constructs an instance with the given callback. It will be called for each item in the collection to set the binding info.
    
    See Also:
    
    OnItemBind
  - set
```
public final ItemBinding<T> set(int variableId,
                                int layoutRes)
```
    Set the variable id and layout. This is normally called in OnItemBind.onItemBind(ItemBinding, int, Object).
  - variableId
```
public final ItemBinding<T> variableId(int variableId)
```
    Set the variable id. This is normally called in OnItemBind.onItemBind(ItemBinding, int, Object).
  - layoutRes
```
public final ItemBinding<T> layoutRes(int layoutRes)
```
    Set the layout. This is normally called in OnItemBind.onItemBind(ItemBinding, int, Object).
  - bindExtra
```
public final ItemBinding<T> bindExtra(int variableId,
                                      java.lang.Object value)
```
    Bind an extra variable to the view with the given variable id. The same instance will be provided to all views the binding is bound to.
  - clearExtras
```
public final ItemBinding<T> clearExtras()
```
    Clear all extra variables. This is normally called in OnItemBind.onItemBind(ItemBinding, int, Object).
  - removeExtra
```
public ItemBinding<T> removeExtra(int variableId)
```
    Remove an extra variable with the given variable id. This is normally called in OnItemBind.onItemBind(ItemBinding, int, Object).
  - variableId
```
public final int variableId()
```
    Returns the current variable id of this binding.
  - layoutRes
```
public final int layoutRes()
```
    Returns the current layout fo this binding.
  - extraBinding
```
public final java.lang.Object extraBinding(int variableId)
```
    Returns the current extra binding for the given variable id or null if one isn't present.
  - onItemBind
```
public void onItemBind(int position,
                       T item)
```
    Updates the state of the binding for the given item and position. This is called internally by the binding collection adapters.
  - bind
```
public boolean bind(ViewDataBinding binding,
                    T item)
```
    Binds the item and extra bindings to the given binding. Returns true if anything was bound and false otherwise. This is called internally by the binding collection adapters.
    
    Throws:
    
    java.lang.IllegalStateException - if the variable id isn't present in the layout.

Class ItemBinding<T>

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

VAR_NONE

Method Detail

of

of

set

variableId

layoutRes

bindExtra

clearExtras

removeExtra

variableId

layoutRes

extraBinding

onItemBind

bind