com.vk.sdk.api.model

Class VKApiModel

java.lang.Object

com.vk.sdk.api.model.VKApiModel

All Implemented Interfaces:

android.os.Parcelable

Direct Known Subclasses:

VKApiChat, VKApiCity, VKApiComment, VKApiCommunityFull.Contact, VKApiCommunityFull.Link, VKApiCountry, VKApiDialog, VKApiGetDialogResponse, VKApiGetMessagesResponse, VKApiMessage, VKApiOwner, VKApiPhotoSize, VKApiPlace, VKApiPoll.Answer, VKApiSchool, VKApiUniversity, VKApiUserFull.Relative, VKAttachments.VKApiAttachment, VKList, VKWallPostResult

public abstract class VKApiModel
extends java.lang.Object
implements android.os.Parcelable

Root class for all VK models. Any VK model supports Parcelable interface so you can pass it as extra. VK model is also allows you to store some object inside as a tag. These objects are retained by hard links, and never will be saved during parcelization.

Nested Class Summary

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
org.json.JSONObject	fields

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
VKApiModel() Creates empty model
VKApiModel(org.json.JSONObject from)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getTag() Returns this model's tag.
java.lang.Object	getTag(int key) Returns the tag associated with this model and the specified key.
VKApiModel	parse(org.json.JSONObject response) Parses object from source.
void	setTag(int key, java.lang.Object tag) Sets a tag associated with this model and a key.
void	setTag(java.lang.Object tag) Sets the tag associated with this model.

Methods inherited from class java.lang.Object

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

Methods inherited from interface android.os.Parcelable

describeContents, writeToParcel

Field Detail

fields

public org.json.JSONObject fields

Constructor Detail

VKApiModel

public VKApiModel()

Creates empty model

VKApiModel

public VKApiModel(org.json.JSONObject from)
           throws org.json.JSONException

Throws:

org.json.JSONException

Method Detail

getTag

public java.lang.Object getTag()

Returns this model's tag.

Returns:

the Object stored in this model as a tag

See Also:

setTag(Object), getTag(int)

setTag

public void setTag(java.lang.Object tag)

Sets the tag associated with this model. A tag can be used to store data within a model without resorting to another data structure.

Parameters:

tag - an Object to tag the model with

See Also:

getTag(), setTag(int, Object)

getTag

public java.lang.Object getTag(int key)

Returns the tag associated with this model and the specified key.

Parameters:

key - The key identifying the tag

Returns:

the Object stored in this model as a tag

See Also:

setTag(int, Object), getTag()

setTag

public void setTag(int key,
                   java.lang.Object tag)

Sets a tag associated with this model and a key. A tag can be used to store data within a model without resorting to another data structure.

See Also:

setTag(Object), getTag(int)

parse

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

Parses object from source.

Parameters:

response - server API object.

Returns:

this object.

Throws:

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