com.datasift.client.dynamiclist

Class DataSiftDynamicList

java.lang.Object

com.datasift.client.DataSiftApiClient

com.datasift.client.dynamiclist.DataSiftDynamicList

public class DataSiftDynamicList
extends DataSiftApiClient

Author:

Christopher Gilbert

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataSiftDynamicList.ListType

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADD
static String	CREATE
static String	DELETE
static String	EXISTS
static String	GET
static String	REMOVE

Fields inherited from class com.datasift.client.DataSiftApiClient

config

Constructor Summary

Constructors

Constructor and Description
DataSiftDynamicList(DataSiftConfig config)

Method Summary

Methods

Modifier and Type	Method and Description
<T> FutureData<DataSiftResult>	add(DynamicList list, List<T> items) Add one or more items to a dynamic list with the given id
FutureData<DynamicList>	create(DataSiftDynamicList.ListType type, String name) Create a new dynamic list with the given name and type
FutureData<DataSiftResult>	delete(DynamicList list) Delete a dynamic list with the given id
<T> FutureData<DataSiftResult>	exists(DynamicList list, List<T> items) Check if one or more items exist in a dynamic list with the given id
FutureData<DataSiftResult>	get() Retrieve all lists owned by the user given by the API credentials
<T> FutureData<DataSiftResult>	remove(DynamicList list, List<T> items) Remove one or more items from a dynamic list with the given id

Methods inherited from class com.datasift.client.DataSiftApiClient

failNotify, newParams, newRequestCallback, performRequest, unwrapFuture

Methods inherited from class java.lang.Object

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

Field Detail

GET

public static final String GET

See Also:

Constant Field Values

CREATE

public static final String CREATE

See Also:

Constant Field Values

DELETE

public static final String DELETE

See Also:

Constant Field Values

EXISTS

public static final String EXISTS

See Also:

Constant Field Values

ADD

public static final String ADD

See Also:

Constant Field Values

REMOVE

public static final String REMOVE

See Also:

Constant Field Values

Constructor Detail

DataSiftDynamicList

public DataSiftDynamicList(DataSiftConfig config)

Method Detail

get

public FutureData<DataSiftResult> get()

Retrieve all lists owned by the user given by the API credentials

Returns:

this

create

public FutureData<DynamicList> create(DataSiftDynamicList.ListType type,
                             String name)

Create a new dynamic list with the given name and type

Parameters:

type - the type of the list to create

name - a user specified string to identify the list

Returns:

this

delete

public FutureData<DataSiftResult> delete(DynamicList list)

Delete a dynamic list with the given id

Parameters:

list - the list to delete

Returns:

this

exists

public <T> FutureData<DataSiftResult> exists(DynamicList list,
                                    List<T> items)

Check if one or more items exist in a dynamic list with the given id

Type Parameters:

T - the type of the items to check, may be either string or integer, and must match the type of the list

Parameters:

list - the list to check for items

items - the list of items to check

Returns:

this

add

public <T> FutureData<DataSiftResult> add(DynamicList list,
                                 List<T> items)

Add one or more items to a dynamic list with the given id

Type Parameters:

T - the type of the items to add, may be either string or integer, and must match the type of the list

Parameters:

list - the list to add items to

items - the list of items to add

Returns:

this

remove

public <T> FutureData<DataSiftResult> remove(DynamicList list,
                                    List<T> items)

Remove one or more items from a dynamic list with the given id

Type Parameters:

T - the type of the items to remove, may be either string or integer, and must match the type of the list

Parameters:

list - the list to remove items from

items - the list of items to remove

Returns:

this