com.vk.sdk.api.model

Class VKList<T extends VKApiModel & android.os.Parcelable & Identifiable>

java.lang.Object

com.vk.sdk.api.model.VKApiModel

com.vk.sdk.api.model.VKList<T>

Type Parameters:

T - type of stored values.

All Implemented Interfaces:

android.os.Parcelable, java.lang.Iterable<T>, java.util.Collection<T>, java.util.List<T>

Direct Known Subclasses:

VKApiCommunityArray, VKAttachments, VkAudioArray, VKCommentArray, VKDocsArray, VKNotesArray, VKPhotoArray, VKPhotoSizes, VKPostArray, VKUsersArray, VkVideoArray

public class VKList<T extends VKApiModel & android.os.Parcelable & Identifiable>
extends VKApiModel
implements java.util.List<T>, android.os.Parcelable

Universal data list for VK API. This class is not thread-safe.

See Also:

http://vk.com/dev/list

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	VKList.Parser<D> Used when parsing the list objects as interator created from JSONArray a instances of items of the list.
static class	VKList.ReflectParser<D extends VKApiModel> Parser list items using reflection mechanism.

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator<VKList>	CREATOR

Fields inherited from class com.vk.sdk.api.model.VKApiModel

fields

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
VKList() Creates empty list.
VKList(org.json.JSONArray from, java.lang.Class<? extends T> clazz) Creates list and fills it according with data in from.
VKList(org.json.JSONArray from, VKList.Parser<T> creator) Creates list and fills it according with data in from.
VKList(org.json.JSONObject from, java.lang.Class<? extends T> clazz) Creates list and fills it according with data in from.
VKList(org.json.JSONObject from, VKList.Parser<T> creator) Creates list and fills it according with data in from.
VKList(java.util.List<? extends T> data) Creates list and fills it according with given data.
VKList(android.os.Parcel in) Creates list from Parcel

Method Summary

Modifier and Type	Method and Description
void	add(int location, T object)
boolean	add(T object)
void	addAfter(int id, T data) Adds the element after the element with the specified id.
boolean	addAll(java.util.Collection<? extends T> collection)
boolean	addAll(int location, java.util.Collection<? extends T> collection)
void	addBefore(int id, T data) Adds the element before the element with the specified id.
void	clear()
boolean	contains(java.lang.Object object)
boolean	containsAll(java.util.Collection<?> collection)
int	describeContents()
boolean	equals(java.lang.Object object)
void	fill(org.json.JSONArray from, java.lang.Class<? extends T> clazz) Creates list and fills it according with data in from.
void	fill(org.json.JSONArray from, VKList.Parser<? extends T> creator) Fills list according with data in from.
void	fill(org.json.JSONObject from, java.lang.Class<? extends T> clazz) Fills list according with data in from.
void	fill(org.json.JSONObject from, VKList.Parser<? extends T> creator) Fills list according with data in from.
T	get(int location)
T	getById(int id) Returns element according with id.
int	getCount() Returns the return value of the field VK API count, if it has been returned, and the size of the list, if not.
int	indexOf(java.lang.Object object)
boolean	isEmpty()
java.util.Iterator<T>	iterator()
int	lastIndexOf(java.lang.Object object)
java.util.ListIterator<T>	listIterator()
java.util.ListIterator<T>	listIterator(int location)
VKApiModel	parse(org.json.JSONObject response) Parses object from source.
T	remove(int location)
boolean	remove(java.lang.Object object)
boolean	removeAll(java.util.Collection<?> collection)
boolean	retainAll(java.util.Collection<?> collection)
VKList<T>	search(java.lang.String query) Searches through the list of available items.
T	set(int location, T object)
int	size()
java.util.List<T>	subList(int start, int end)
java.lang.Object[]	toArray()
<T1> T1[]	toArray(T1[] array)
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class com.vk.sdk.api.model.VKApiModel

getTag, getTag, setTag, setTag

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

hashCode, replaceAll, sort, spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

CREATOR

public static android.os.Parcelable.Creator<VKList> CREATOR

Constructor Detail

VKList

public VKList()

Creates empty list.

VKList

public VKList(java.util.List<? extends T> data)

Creates list and fills it according with given data.

VKList

public VKList(org.json.JSONObject from,
              java.lang.Class<? extends T> clazz)

Creates list and fills it according with data in from.

Parameters:

from - an object that represents a list adopted in accordance with VK API format. You can use null.

clazz - class represents a model that has a public constructor with JSONObject argument.

VKList

public VKList(org.json.JSONArray from,
              java.lang.Class<? extends T> clazz)

Creates list and fills it according with data in from.

Parameters:

from - an array of items in the list. You can use null.

clazz - class represents a model that has a public constructor with JSONObject argument.

VKList

public VKList(org.json.JSONObject from,
              VKList.Parser<T> creator)

Creates list and fills it according with data in from.

Parameters:

from - an object that represents a list adopted in accordance with VK API format. You can use null.

creator - interface implementation to parse objects.

VKList

public VKList(org.json.JSONArray from,
              VKList.Parser<T> creator)

Creates list and fills it according with data in from.

Parameters:

from - an array of items in the list. You can use null.

creator - interface implementation to parse objects.

VKList

public VKList(android.os.Parcel in)

Creates list from Parcel

Method Detail

fill

public void fill(org.json.JSONObject from,
                 java.lang.Class<? extends T> clazz)

Fills list according with data in from.

Parameters:

from - an object that represents a list adopted in accordance with VK API format. You can use null.

clazz - class represents a model that has a public constructor with JSONObject argument.

fill

public void fill(org.json.JSONArray from,
                 java.lang.Class<? extends T> clazz)

Creates list and fills it according with data in from.

Parameters:

from - an array of items in the list. You can use null.

clazz - class represents a model that has a public constructor with JSONObject argument.

fill

public void fill(org.json.JSONObject from,
                 VKList.Parser<? extends T> creator)

Fills list according with data in from.

Parameters:

from - an object that represents a list adopted in accordance with VK API format. You can use null.

creator - interface implementation to parse objects.

fill

public void fill(org.json.JSONArray from,
                 VKList.Parser<? extends T> creator)

Fills list according with data in from.

Parameters:

from - an array of items in the list. You can use null.

creator - interface implementation to parse objects.

addBefore

public void addBefore(int id,
                      T data)

Adds the element before the element with the specified id. If an element with the specified id is not found, adds an element to the end of the list.

Parameters:

id - element identifier to add element before it.

data - element to add

addAfter

public void addAfter(int id,
                     T data)

Adds the element after the element with the specified id. If an element with the specified id is not found, adds an element to the end of the list.

Parameters:

id - element identifier to add element after it.

data - element to add

getById

public T getById(int id)

Returns element according with id. If nothing found, returns null.

search

public VKList<T> search(java.lang.String query)

Searches through the list of available items.

The search will be carried out not by the content of characters per line, and the content of them in separate words.

Search is not case sensitive.

To support search class T must have overridden method Object.toString(), search will be carried out exactly according to the result of calling this method.


Suppose there are elements in the list of contents:

 - Hello world
 - Hello test
 

In this case, the matches will be on search phrases 'Hel', 'Hello', 'test', but not on 'llo', 'llo world'

Parameters:

query - search query can not be equal to null, but can be an empty string.

Returns:

created based on the search results new list. If no matches are found, the list will be empty.

getCount

public int getCount()

Returns the return value of the field VK API count, if it has been returned, and the size of the list, if not.

add

public void add(int location,
                T object)

Specified by:

add in interface java.util.List<T extends VKApiModel & android.os.Parcelable & Identifiable>

add

public boolean add(T object)

Specified by:

add in interface java.util.Collection<T extends VKApiModel & android.os.Parcelable & Identifiable>

Specified by:

add in interface java.util.List<T extends VKApiModel & android.os.Parcelable & Identifiable>

addAll

public boolean addAll(int location,
                      @NonNull
                      java.util.Collection<? extends T> collection)

Specified by:

addAll in interface java.util.List<T extends VKApiModel & android.os.Parcelable & Identifiable>

addAll

public boolean addAll(@NonNull
                      java.util.Collection<? extends T> collection)

Specified by:

addAll in interface java.util.Collection<T extends VKApiModel & android.os.Parcelable & Identifiable>

Specified by:

addAll in interface java.util.List<T extends VKApiModel & android.os.Parcelable & Identifiable>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<T extends VKApiModel & android.os.Parcelable & Identifiable>

Specified by:

clear in interface java.util.List<T extends VKApiModel & android.os.Parcelable & Identifiable>

contains

public boolean contains(java.lang.Object object)

Specified by:

contains in interface java.util.Collection<T extends VKApiModel & android.os.Parcelable & Identifiable>

Specified by:

contains in interface java.util.List<T extends VKApiModel & android.os.Parcelable & Identifiable>

containsAll

public boolean containsAll(@NonNull
                           java.util.Collection<?> collection)

Specified by:

containsAll in interface java.util.Collection<T extends VKApiModel & android.os.Parcelable & Identifiable>

Specified by:

containsAll in interface java.util.List<T extends VKApiModel & android.os.Parcelable & Identifiable>

equals

public boolean equals(java.lang.Object object)

Specified by:

equals in interface java.util.Collection<T extends VKApiModel & android.os.Parcelable & Identifiable>

Specified by:

equals in interface java.util.List<T extends VKApiModel & android.os.Parcelable & Identifiable>

Overrides:

equals in class java.lang.Object

get

public T get(int location)

Specified by:

get in interface java.util.List<T extends VKApiModel & android.os.Parcelable & Identifiable>

indexOf

public int indexOf(java.lang.Object object)

Specified by:

indexOf in interface java.util.List<T extends VKApiModel & android.os.Parcelable & Identifiable>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection<T extends VKApiModel & android.os.Parcelable & Identifiable>

Specified by:

isEmpty in interface java.util.List<T extends VKApiModel & android.os.Parcelable & Identifiable>

iterator

@NonNull
public java.util.Iterator<T> iterator()

Specified by:

iterator in interface java.lang.Iterable<T extends VKApiModel & android.os.Parcelable & Identifiable>

Specified by:

iterator in interface java.util.Collection<T extends VKApiModel & android.os.Parcelable & Identifiable>

Specified by:

iterator in interface java.util.List<T extends VKApiModel & android.os.Parcelable & Identifiable>

lastIndexOf

public int lastIndexOf(java.lang.Object object)

Specified by:

lastIndexOf in interface java.util.List<T extends VKApiModel & android.os.Parcelable & Identifiable>

listIterator

public java.util.ListIterator<T> listIterator()

Specified by:

listIterator in interface java.util.List<T extends VKApiModel & android.os.Parcelable & Identifiable>

listIterator

@NonNull
public java.util.ListIterator<T> listIterator(int location)

Specified by:

listIterator in interface java.util.List<T extends VKApiModel & android.os.Parcelable & Identifiable>

remove

public T remove(int location)

Specified by:

remove in interface java.util.List<T extends VKApiModel & android.os.Parcelable & Identifiable>

remove

public boolean remove(java.lang.Object object)

Specified by:

remove in interface java.util.Collection<T extends VKApiModel & android.os.Parcelable & Identifiable>

Specified by:

remove in interface java.util.List<T extends VKApiModel & android.os.Parcelable & Identifiable>

removeAll

public boolean removeAll(@NonNull
                         java.util.Collection<?> collection)

Specified by:

removeAll in interface java.util.Collection<T extends VKApiModel & android.os.Parcelable & Identifiable>

Specified by:

removeAll in interface java.util.List<T extends VKApiModel & android.os.Parcelable & Identifiable>

retainAll

public boolean retainAll(@NonNull
                         java.util.Collection<?> collection)

Specified by:

retainAll in interface java.util.Collection<T extends VKApiModel & android.os.Parcelable & Identifiable>

Specified by:

retainAll in interface java.util.List<T extends VKApiModel & android.os.Parcelable & Identifiable>

set

public T set(int location,
             T object)

Specified by:

set in interface java.util.List<T extends VKApiModel & android.os.Parcelable & Identifiable>

size

public int size()

Specified by:

size in interface java.util.Collection<T extends VKApiModel & android.os.Parcelable & Identifiable>

Specified by:

size in interface java.util.List<T extends VKApiModel & android.os.Parcelable & Identifiable>

subList

@NonNull
public java.util.List<T> subList(int start,
                                          int end)

Specified by:

subList in interface java.util.List<T extends VKApiModel & android.os.Parcelable & Identifiable>

toArray

@NonNull
public java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.Collection<T extends VKApiModel & android.os.Parcelable & Identifiable>

Specified by:

toArray in interface java.util.List<T extends VKApiModel & android.os.Parcelable & Identifiable>

toArray

@NonNull
public <T1> T1[] toArray(@NonNull
                                  T1[] array)

Specified by:

toArray in interface java.util.Collection<T extends VKApiModel & android.os.Parcelable & Identifiable>

Specified by:

toArray in interface java.util.List<T extends VKApiModel & android.os.Parcelable & Identifiable>

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable

parse

public VKApiModel parse(org.json.JSONObject response)
                 throws org.json.JSONException

Description copied from class: VKApiModel

Parses object from source.

Overrides:

parse in class VKApiModel

Parameters:

response - server API object.

Returns:

this object.

Throws:

org.json.JSONException - if any critical error occurred while parsing.