Variant
extends Object| java.lang.Object | |
| ↳ | org.neshan.core.Variant |
Class Overview
این کلاس می‌تواند داده‌های ساختارمندی با فرمت JSON از جمله اشیاء و آرایه‌ها را دربرداشته باشد.
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
Variant()
یک شی null از نوع Variant می‌سازد.
| |||||||||||
|
Variant(boolean boolVal)
از یک مقدار boolean یک شی از نوع Variant می‌سازد.
| |||||||||||
|
Variant(long longVal)
از یک مقدار صحیح یک شی از نوع Variant می‌سازد.
| |||||||||||
|
Variant(double doubleVal)
از یک مقدار double یک شی از نوع Variant می سازد.
| |||||||||||
|
Variant(String string)
از یک رشته یک شی از نوع Variant می‌سازد.
| |||||||||||
|
Variant(VariantVector array)
از یک لیستی از مقادیر یک شی از نوع Variant می‌سازد.
| |||||||||||
|
Variant(StringVariantMap object)
از یک مپ از مقادیر یک شی از نوع Variant می‌سازد.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| boolean |
containsObjectKey(String key)
در صورت وجود این کلید مقدار True بر می‌گرداند.
| ||||||||||
| synchronized void | delete() | ||||||||||
| boolean |
equals(Object obj)
برابری این شی با شی مشخص شده را بررسی می‌کند.
| ||||||||||
| static Variant |
fromString(String str)
با استفاده از یک رشته JSON یک شی از نوع Variant می‌سازد.
| ||||||||||
| Variant |
getArrayElement(int idx)
المان آرایه در موقعیت مشخص‌شده را برمی‌گرداند.
| ||||||||||
| int |
getArraySize()
تعداد المان‌ها در آرایه را برمی‌گرداند.
| ||||||||||
| boolean |
getBool()
مقدار boolean این Variant را برمی‌گرداند.
| ||||||||||
| double |
getDouble()
معادل double این شی را برمی‌گرداند.
| ||||||||||
| long |
getLong()
مقدار صحیح این Variant را برمی‌گرداند.
| ||||||||||
| Variant |
getObjectElement(String key)
شی با کلید مشخص‌شده را برمی‌گرداند.
| ||||||||||
| StringVector |
getObjectKeys()
تمام کلیدهای داخل شی را برمی‌گرداند.
| ||||||||||
| String |
getString()
مقدار رشته متنی این Variant را برمی‌گرداند.
| ||||||||||
| VariantType |
getType()
نوع این Variant را برمی‌گرداند.
| ||||||||||
| int |
hashCode()
معادل hash شده‌ی این این شی را برمی‌گرداند.
| ||||||||||
| String |
toString()
این شی Variant را به رشته‌ای با قالب JSON تبدیل می‌کند.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Public Constructors
public Variant ()
یک شی null از نوع Variant می‌سازد.
public Variant (boolean boolVal)
از یک مقدار boolean یک شی از نوع Variant می‌سازد.
Parameters
| boolVal | مقدار boolean. |
|---|
public Variant (long longVal)
از یک مقدار صحیح یک شی از نوع Variant می‌سازد.
Parameters
| longVal | مقدار صحیح. |
|---|
public Variant (double doubleVal)
از یک مقدار double یک شی از نوع Variant می سازد.
Parameters
| doubleVal | مقدار double. |
|---|
public Variant (String string)
از یک رشته یک شی از نوع Variant می‌سازد.
Parameters
| string | مقدار string. |
|---|
public Variant (VariantVector array)
از یک لیستی از مقادیر یک شی از نوع Variant می‌سازد.
Parameters
| array | آرایه‌ی از مقادیر json |
|---|
public Variant (StringVariantMap object)
از یک مپ از مقادیر یک شی از نوع Variant می‌سازد.
Parameters
| object | مپ مقادیر json |
|---|
Public Methods
public boolean containsObjectKey (String key)
در صورت وجود این کلید مقدار True بر می‌گرداند.
Parameters
| key | نام کلید. |
|---|
Returns
- اگر کلید وجود داشته باشد True و در صورتی که شی از نوع آبجکت نباشید یا کلید وجود نداشته باشد False
public synchronized void delete ()
public boolean equals (Object obj)
برابری این شی با شی مشخص شده را بررسی می‌کند.
Parameters
| obj | شی مورد نظر |
|---|
Returns
- در صورتی که دو شی یکسان باشند True و در غیر اینصورت False
public static Variant fromString (String str)
با استفاده از یک رشته JSON یک شی از نوع Variant می‌سازد.
Parameters
| str | رشته متنی با فرمت JSON |
|---|
Returns
- شی Variant مرتبط
public Variant getArrayElement (int idx)
المان آرایه در موقعیت مشخص‌شده را برمی‌گرداند.
Parameters
| idx | اندیس آرایه‌ی مورد نظر |
|---|
Returns
- المان آرایه در موقعیت مشخص‌شده را برمی‌گرداند
public int getArraySize ()
تعداد المان‌ها در آرایه را برمی‌گرداند.
Returns
- تعداد المان‌ها در آرایه
public boolean getBool ()
مقدار boolean این Variant را برمی‌گرداند.
Returns
- مقدار boolean این Variant.اگر Variant boolean نباشد مقدار false برگردانده می‌شود.
public double getDouble ()
معادل double این شی را برمی‌گرداند.
Returns
- معادل double این شی. اگر این شی صحیح است به اعشاری تبدیل می‌گردد در غیر اینصورت 0.0 برگردانده می‌شود
public long getLong ()
مقدار صحیح این Variant را برمی‌گرداند.
Returns
- مقدار صحیح این Variant.اگر Variant صحیح نمی‌باشد مقدار 0 برگردانده می‌شود.
public Variant getObjectElement (String key)
شی با کلید مشخص‌شده را برمی‌گرداند.
Parameters
| key | کلید شی که باید برگردانده شود. |
|---|
Returns
- اگر شی با کلید مشخص‌شده موجود باشد، شی Variant را برمی گرداند
public StringVector getObjectKeys ()
تمام کلیدهای داخل شی را برمی‌گرداند.
Returns
- لیستی از همه کلیدهای شی
public String getString ()
مقدار رشته متنی این Variant را برمی‌گرداند.
Returns
- مقدار رشته متنی این Variant. اگر Variant رشته متنی نباشد رشته خالی برگردانده می‌شود
public int hashCode ()
معادل hash شده‌ی این این شی را برمی‌گرداند.
Returns
- معادل hash شده‌ی این شی
public String toString ()
این شی Variant را به رشته‌ای با قالب JSON تبدیل می‌کند.
Returns
- رشته‌ی JSON این شی Variant