Payload (flexible-adapter 5.1.0 API)

java.lang.Object
- java.lang.Enum<Payload>
- - eu.davidea.flexibleadapter.Payload

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Payload>
```
public enum Payload
extends java.lang.Enum<Payload>
```
Payload occurs only for notifyItemChanged().
The value of this enumeration will be provided to the bind method to optimize the view binding in order to update only the inner views interested for the change.
You can still pass your own Object instead of one of these values.

Since:

5.0.0-b8 16/07/2016

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ADD_SUB_ITEM` when a subItem is added to the siblings below a parent
`CHANGE` for a general update of the content item
`COLLAPSED` when an item is collapsed by the user or system
`EXPANDED` when an item is expanded by the user or system
`FILTER` when the filter has changed and item is still visible
`LINK` when linking a header from a sectionable item
`MERGE` when items are notified after a merge
`MOVE` when item has been moved, the original header/parent receives this payload
`NO_MORE_LOAD` when no more load is triggered
`REM_SUB_ITEM` when a subItem is removed from the siblings below a parent
`SELECTION` when items are notified due to Selecting All items / Clearing Selection)
`SPLIT` when items are notified after a split
`UNDO` when header or parent receive back its child after the restoration
`UNLINK` when un-linking a header from a sectionable item

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Payload`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static Payload[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - CHANGE
```
public static final Payload CHANGE
```
    for a general update of the content item
  - NO_MORE_LOAD
```
public static final Payload NO_MORE_LOAD
```
    when no more load is triggered
  - FILTER
```
public static final Payload FILTER
```
    when the filter has changed and item is still visible
  - UNDO
```
public static final Payload UNDO
```
    when header or parent receive back its child after the restoration
  - ADD_SUB_ITEM
```
public static final Payload ADD_SUB_ITEM
```
    when a subItem is added to the siblings below a parent
  - REM_SUB_ITEM
```
public static final Payload REM_SUB_ITEM
```
    when a subItem is removed from the siblings below a parent
  - MOVE
```
public static final Payload MOVE
```
    when item has been moved, the original header/parent receives this payload
  - LINK
```
public static final Payload LINK
```
    when linking a header from a sectionable item
  - UNLINK
```
public static final Payload UNLINK
```
    when un-linking a header from a sectionable item
  - SELECTION
```
public static final Payload SELECTION
```
    when items are notified due to Selecting All items / Clearing Selection)
  - MERGE
```
public static final Payload MERGE
```
    when items are notified after a merge
  - SPLIT
```
public static final Payload SPLIT
```
    when items are notified after a split
  - EXPANDED
```
public static final Payload EXPANDED
```
    when an item is expanded by the user or system
  - COLLAPSED
```
public static final Payload COLLAPSED
```
    when an item is collapsed by the user or system
- Method Detail
  - values
```
public static Payload[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (Payload c : Payload.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Payload valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null

Enum Payload

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

CHANGE

NO_MORE_LOAD

FILTER

UNDO

ADD_SUB_ITEM

REM_SUB_ITEM

MOVE

LINK

UNLINK

SELECTION

MERGE

SPLIT

EXPANDED

COLLAPSED

Method Detail

values

valueOf