Package com.contentstack.sdk

Class Group

java.lang.Object

com.contentstack.sdk.Group

public class Group
extends Object

Group is to get different types of DataType of data fromt the JSON response

Method Summary

Modifier and Type	Method	Description
Object	get(String key)	Get object value for key.
List<Entry>	getAllEntries(String refKey, String refContentType)	Get value for the given reference key.
Asset	getAsset(String key)	Get an asset from the group
List<Asset>	getAssets(String key)	Get an assets from the group.
Boolean	getBoolean(String key)	Get boolean value for key.
Calendar	getDate(String key)	Get Calendar value for key
double	getDouble(String key)	Get double value for key
float	getFloat(String key)	Get integer value for key
Group	getGroup(String key)	Get a group from the group.
List<Group>	getGroups(String key)	Get a list of group from the group.
int	getInt(String key)	Get integer value for key
org.json.JSONArray	getJSONArray(String key)	Get JSONArray value for key
org.json.JSONObject	getJSONObject(String key)	Get JSONObject value for key
long	getLong(String key)	Get long value for key
Number	getNumber(String key)	Get JSONObject value for key
short	getShort(String key)	Get short value for key
String	getString(String key)	Get string value for key.
org.json.JSONObject	toJSON()	Get group representation in json

Methods inherited from class java.lang.Object

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

Method Detail

toJSON

public org.json.JSONObject toJSON()

Get group representation in json

Returns:

JSONObject

Example :

         JSONObject json = group.toJSON();
         

get

public Object get(String key)

Get object value for key.

Parameters:

key - field_uid as key.

Returns:

JSONObject

Example :

         Object obj = group.get("key");
         

getString

public String getString(String key)

Get string value for key.

Parameters:

key - field_uid as key.

Returns:

String

Example :

         String value = group.getString("key");
         

getBoolean

public Boolean getBoolean(String key)

Get boolean value for key.

Parameters:

key - field_uid as key.

Returns:

boolean true or false

Example :

         Boolean value = group.getBoolean("key");
         

getJSONArray

public org.json.JSONArray getJSONArray(String key)

Get JSONArray value for key

Parameters:

key - field_uid as key.

Returns:

JSONArray

Example :

         JSONArray value = group.getJSONArray("key");
         

getJSONObject

public org.json.JSONObject getJSONObject(String key)

Get JSONObject value for key

Parameters:

key - field_uid as key.

Returns:

JSONObject

Example :

         JSONObject value = group.getJSONObject("key");
         

getNumber

public Number getNumber(String key)

Get JSONObject value for key

Parameters:

key - field_uid as key.

Returns:

Number

Example :

         JSONObject value = group.getJSONObject("key");
         

getInt

public int getInt(String key)

Get integer value for key

Parameters:

key - field_uid as key.

Returns:

int

Example :

         int value = group.getInt("key");
         

getFloat

public float getFloat(String key)

Get integer value for key

Parameters:

key - field_uid as key.

Returns:

float

Example :

         float value = group.getFloat("key");
         

getDouble

public double getDouble(String key)

Get double value for key

Parameters:

key - field_uid as key.

Returns:

double

Example :

         double value = group.getDouble("key");
         

getLong

public long getLong(String key)

Get long value for key

Parameters:

key - field_uid as key.

Returns:

long

Example :

         long value = group.getLong("key");
         

getShort

public short getShort(String key)

Get short value for key

Parameters:

key - field_uid as key.

Returns:

short

Example :

         short value = group.getShort("key");
         

getDate

public Calendar getDate(String key)

Get Calendar value for key

Parameters:

key - field_uid as key.

Returns:

Date

Example :

         Calendar value = group.getDate("key");
         

getAsset

public Asset getAsset(String key)

Get an asset from the group

Parameters:

key - field_uid as key.

Returns:

Asset object

Example :

         Asset asset = group.getAsset("key");
         

getAssets

public List<Asset> getAssets(String key)

Get an assets from the group. This works with multiple true fields

Parameters:

key - field_uid as key.

Example :

                                                                                                                                              List<Asset> asset = group.getAssets("key"); 

Returns:

ArrayList of Asset

getGroup

public Group getGroup(String key)

Get a group from the group.

Parameters:

key - field_uid as key.

Example :

                                                                                                                  Group innerGroup = group.getGroup("key");
                                                                                                                  @return Group
                                                                                                                  object
                                                                                                                  

Returns:

the group

getGroups

public List<Group> getGroups(String key)

Get a list of group from the group.

Note :- This will work when group is multiple true.

Parameters:

key - field_uid as key.

Example :

                                                                                                                                              Group innerGroup = group.getGroups("key");

Returns:

List of Group

getAllEntries

public List<Entry> getAllEntries(String refKey,
                                 String refContentType)

Get value for the given reference key.

Parameters:

refKey - key of a reference field.

refContentType - class uid.

Returns:

ArrayList of Entry instances. Also specified contentType value will be set as class uid for all Entry instance.