NbObject (モバイルバックエンド基盤 Java / Android SDK リファレンス)

java.lang.Object
- com.nec.baas.object.NbObject

すべての実装されたインタフェース:

java.io.Serializable, java.util.Map<java.lang.String,java.lang.Object>
```
public class NbObject
extends java.lang.Object
implements java.io.Serializable, java.util.Map<java.lang.String,java.lang.Object>
```
オブジェクト管理クラス。
オブジェクトストレージに格納される JSON オブジェクトデータ1件を表現する。
本クラスは Serializable であるが、マルチテナントモード時にはシリアライズできない。 (デシリアライズするときに例外がスローされる)
本クラスのインスタンスはスレッドセーフではない。

導入されたバージョン:

1.0

関連項目:

直列化された形式

ネストされたクラスのサマリー
- インタフェースから継承されたネストされたクラス/インタフェース java.util.Map
  java.util.Map.Entry<K,V>

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明
`NbObject(NbService service, java.lang.String bucketName)` コンストラクタ (マルチテナント対応)。
`NbObject(NbService service, java.lang.String bucketName, NbBucketMode mode)` コンストラクタ(マルチテナント対応)
`NbObject(java.lang.String bucketName)` コンストラクタ (マルチテナント非対応)。
`NbObject(java.lang.String bucketName, NbBucketMode mode)` コンストラクタ(マルチテナント非対応)

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド concreteメソッド非推奨のメソッド
修飾子とタイプ	メソッドと説明
`NbService`	`_getService()`
`void`	`_setJsonObject(NbJSONObject json)`
`void`	`clear()`
`boolean`	`containsKey(java.lang.Object key)` キーに対応する値（フィールド)が存在しているか判定する。
`boolean`	`containsValue(java.lang.Object value)`
`void`	`deleteObject(boolean softDelete, NbResultCallback callback)` オブジェクトの削除を行う。
`void`	`deleteObject(NbResultCallback callback)` オブジェクトの削除を行う。
`java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>>`	`entrySet()` オブジェクトに格納されたキー・値の Entry Set を返す
`boolean`	`equals(java.lang.Object o)`
`java.lang.Object`	`get(java.lang.Object key)`
`NbAcl`	`getAcl()` オブジェクトに設定されたACL。
`java.lang.Object`	`getAny(java.lang.String key, java.lang.Object defAny)` 指定したkeyに対応するデータを Object として取得する。
`java.lang.Boolean`	`getBoolean(java.lang.String key, java.lang.Boolean defBoolean)` 指定したkeyに対応するデータを真偽値として取得する。
`java.lang.String`	`getBucketName()` バケット名
`java.lang.String`	`getCreatedTime()` オブジェクトの作成日時。
`java.lang.String`	`getCreateTime()` 非推奨です。 `getCreatedTime()` で置き換え
`java.lang.String`	`getETag()` ETag
`java.lang.String`	`getImportance()` オブジェクトに設定されたImportanceを取得する。
`NbJSONArray`	`getJSONArray(java.lang.String key, NbJSONArray defArray)` 指定したkeyに対応するデータを NbJSONArray として取得する。
`NbJSONObject`	`getJSONObject(java.lang.String key, NbJSONObject defJson)` 指定したkeyに対応するデータを NbJSONObject として取得する。
`java.lang.String`	`getLastSyncTime()` オブジェクトの最終更新日時を取得する。
`NbBucketMode`	`getMode()` オブジェクトのモードを取得する。
`java.lang.Number`	`getNumber(java.lang.String key, java.lang.Number defNumber)` 指定したkeyに対応するデータを数値として取得する。
`NbJSONObject`	`getObjectData()` オブジェクトに設定されたデータを NbJSONObject 形式で取得する。
`java.lang.String`	`getObjectId()` サーバから割り当てられたオブジェクトID。
`java.lang.String`	`getString(java.lang.String key, java.lang.String defString)` 指定したkeyに対応するデータを文字列として取得する。
`NbSyncState`	`getSyncState()` オブジェクトの同期状態を取得する。
`java.lang.String`	`getUpdatedTime()` オブジェクトの更新日時。
`int`	`hashCode()`
`boolean`	`isEmpty()`
`boolean`	`isNull(java.lang.String key)` キーに対応する値が null であるか、もしくは値が存在しないかを判定する
`static boolean`	`isValidFieldName(java.lang.String fieldName)` フィールド名が正しいかチェックする。
`java.util.Set<java.lang.String>`	`keySet()` オブジェクトに格納されたキーのSetを取得する。
`void`	`partUpdateObject(java.util.Map<java.lang.String,java.lang.Object> data, NbObjectCallback callback)` 非推奨です。 `partUpdateObject(NbJSONObject, NbCallback)` で置き換え
`void`	`partUpdateObject(NbJSONObject data, NbCallback<NbObject> callback)` オブジェクトデータの部分更新を行う。
`void`	`partUpdateObject(NbJSONObject data, NbObjectCallback callback)` 非推奨です。 `partUpdateObject(NbJSONObject, NbCallback)` で置き換え
`java.lang.Object`	`put(java.lang.String key, java.lang.Object value)` 指定された key に対応する value をオブジェクトに設定する。
`void`	`putAcl(NbAcl acl)` 指定されたACLをオブジェクトに設定する。
`void`	`putAll(java.util.Map<? extends java.lang.String,?> map)`
`java.lang.Object`	`remove(java.lang.Object key)`
`void`	`remove(java.lang.String key)` オブジェクトから指定された key のデータを削除する。
`void`	`resetImportance()` オブジェクトに設定されたImportanceを解除する。
`void`	`save(NbCallback<NbObject> callback)` 書き込まれたオブジェクトデータの保存を行う。
`void`	`save(NbObjectCallback callback)` 非推奨です。 `save(NbCallback)` で置き換え
`NbObject`	`setAcl(NbAcl mAcl)` オブジェクトに設定されたACL。
`NbObject`	`setBucketName(java.lang.String mBucketName)` バケット名
`NbObject`	`setCreatedTime(java.lang.String mCreatedTime)` オブジェクトの作成日時。
`void`	`setCurrentParam(NbJSONObject map, boolean isClear)` 内部インタフェース
`NbObject`	`setETag(java.lang.String mETag)` ETag
`void`	`setImportance(java.lang.String importance)` 指定されたImportanceをオブジェクトに設定する。
`NbObject`	`setObjectId(java.lang.String mObjectId)` サーバから割り当てられたオブジェクトID。
`NbObject`	`setUpdatedTime(java.lang.String mUpdatedTime)` オブジェクトの更新日時。
`int`	`size()`
`NbJSONObject`	`toJSONObject()` NbJSONObject に変換する
`java.lang.String`	`toJSONString()` JSON 文字列に変換する
`java.lang.String`	`toString()`
`java.util.Collection<java.lang.Object>`	`values()`

クラスから継承されたメソッド java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

インタフェースから継承されたメソッド java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- コンストラクタの詳細
  - NbObject
```
public NbObject(java.lang.String bucketName)
```
    コンストラクタ (マルチテナント非対応)。オンラインモードのオブジェクトを生成する。
    
    パラメータ:
    
    bucketName - オブジェクトを格納するバケットの名前。
  - NbObject
```
public NbObject(NbService service,
                java.lang.String bucketName)
```
    コンストラクタ (マルチテナント対応)。オンラインモードのオブジェクトを生成する。
    
    パラメータ:
    
    service - NbService
    
    bucketName - オブジェクトを格納するバケットの名前。
  - NbObject
```
public NbObject(java.lang.String bucketName,
                NbBucketMode mode)
```
    コンストラクタ(マルチテナント非対応)
    
    パラメータ:
    
    bucketName - オブジェクトを格納するバケットの名前。
    
    mode - オブジェクトのモード
  - NbObject
```
public NbObject(NbService service,
                java.lang.String bucketName,
                NbBucketMode mode)
```
    コンストラクタ(マルチテナント対応)
    
    パラメータ:
    
    service - NbService
    
    bucketName - オブジェクトを格納するバケットの名前。
    
    mode - オブジェクトのモード
- メソッドの詳細
  - _setJsonObject
```
public void _setJsonObject(NbJSONObject json)
```
  - _getService
```
public NbService _getService()
```
  - save
```
@Deprecated
public void save(NbObjectCallback callback)
```
    非推奨です。 save(NbCallback) で置き換え
    
    書き込まれたオブジェクトデータの保存を行う。
    
    導入されたバージョン:
    
    1.0
  - save
```
public void save(NbCallback<NbObject> callback)
```
    書き込まれたオブジェクトデータの保存を行う。
    オブジェクトのデータがバケットに未作成の場合はオブジェクトを作成する。オブジェクトのデータがバケットに作成済みの場合はオブジェクトの上書きを行う。
    オンラインモードの場合、オブジェクトデータをサーバに保存する。レプリカ・ローカルモードの場合、オフライン用データベースに対し保存を実行する。
    
    パラメータ:
    
    callback - 保存したオブジェクトを受け取るコールバック。
    
    導入されたバージョン:
    
    6.5.0
  - partUpdateObject
```
@Deprecated
public void partUpdateObject(java.util.Map<java.lang.String,java.lang.Object> data,
                                         NbObjectCallback callback)
```
    非推奨です。 partUpdateObject(NbJSONObject, NbCallback) で置き換え
    
    オブジェクトデータの部分更新を行う。
  - partUpdateObject
```
@Deprecated
public void partUpdateObject(NbJSONObject data,
                                         NbObjectCallback callback)
```
    非推奨です。 partUpdateObject(NbJSONObject, NbCallback) で置き換え
    
    オブジェクトデータの部分更新を行う。
  - partUpdateObject
```
public void partUpdateObject(NbJSONObject data,
                             NbCallback<NbObject> callback)
```
    オブジェクトデータの部分更新を行う。
    オブジェクトIDが設定されていない場合、メソッドの実行結果はエラーとなる。
    dataには更新用のデータを格納する。更新用データには MongoDB の更新演算子が使用できる。
```
 
 // 例："name"と"score"を持つオブジェクトの"score"のみ更新する。
 NbJSONObject json = new NbJSONObject();
 json.put("score", 100);
 nebulaObject.partUpdateObject(json, callback);
 
 
```
    オンラインモードの場合、サーバに対し部分更新を実行する。レプリカ・ローカルモードの場合、オフライン用データベースに対し部分更新を実行する。レプリカ・ローカルモードではMongoDBの更新演算子は使用できない。
    パラメータ:
    
    data - オブジェクト更新データを格納した NbJSONObject。
    
    callback - 保存したオブジェクトを受け取るコールバック。
    
    導入されたバージョン:
    
    6.5.0
  - deleteObject
```
public void deleteObject(NbResultCallback callback)
```
    オブジェクトの削除を行う。
    オブジェクトIDが設定されていない場合、メソッドの実行結果はエラーとなる。
    オンラインモードの場合、サーバに対し削除を実行する。
    レプリカ・ローカルモードの場合、オフライン用データベースに対し削除を実行する。
    オフライン中の削除はステータス変更のみ行う。
    
    パラメータ:
    
    callback - オブジェクトの削除結果を取得するコールバック
    
    関連項目:
    
    getObjectId()
  - deleteObject
```
public void deleteObject(boolean softDelete,
                         NbResultCallback callback)
```
    オブジェクトの削除を行う。
    オブジェクトIDが設定されていない場合、メソッドの実行結果はエラーとなる。
    オンラインモードの場合、サーバに対し削除を実行する。
    レプリカ・ローカルモードの場合、オフライン用データベースに対し削除を実行する。
    オフライン中の削除はステータス変更のみ行う。
    
    パラメータ:
    
    softDelete - trueにした場合は論理削除、falseの場合は物理削除
    
    callback - オブジェクトの削除結果を取得するコールバック
    
    関連項目:
    
    getObjectId()
  - getString
```
public java.lang.String getString(java.lang.String key,
                                  java.lang.String defString)
```
    指定したkeyに対応するデータを文字列として取得する。
    keyに対応する型やデータが存在しない場合はdefStringを返す。
    
    パラメータ:
    
    key - 取得するデータのキー
    
    defString - キーが存在しない場合の既定値
    
    戻り値:
    
    取得した文字列
  - getNumber
```
public java.lang.Number getNumber(java.lang.String key,
                                  java.lang.Number defNumber)
```
    指定したkeyに対応するデータを数値として取得する。
    keyに対応する型やデータが存在しない場合はdefNumberを返す。
    
    パラメータ:
    
    key - 取得するデータのキー
    
    defNumber - キーが存在しない場合の既定値
    
    戻り値:
    
    取得した数値
  - getAny
```
public java.lang.Object getAny(java.lang.String key,
                               java.lang.Object defAny)
```
    指定したkeyに対応するデータを Object として取得する。
    取得可能なオブジェクトの型は、以下のいずれか。
    - Number
    - String
    - Boolean
    - NbJSONObject
    - NbJSONArray
    keyに対応するデータが存在しない、取得可能な型でない場合はdefAnyを返す。取得したObjectは適切な型にキャストして使用すること。
    パラメータ:
    
    key - 取得するデータのキー
    
    defAny - キーが存在しない場合の既定値
    
    戻り値:
    
    取得したObject
  - getJSONObject
```
public NbJSONObject getJSONObject(java.lang.String key,
                                  NbJSONObject defJson)
```
    指定したkeyに対応するデータを NbJSONObject として取得する。
    keyに対応する型やデータが存在しない場合は defJson を返す。
    
    パラメータ:
    
    key - 取得するデータのキー
    
    defJson - キーが存在しない場合の既定値
    
    戻り値:
    
    取得したObject
  - getJSONArray
```
public NbJSONArray getJSONArray(java.lang.String key,
                                NbJSONArray defArray)
```
    指定したkeyに対応するデータを NbJSONArray として取得する。
    keyに対応する型やデータが存在しない場合はdefArrayを返す。
    
    パラメータ:
    
    key - 取得するデータのキー
    
    defArray - キーが存在しない場合の既定値
    
    戻り値:
    
    取得した値
  - getBoolean
```
public java.lang.Boolean getBoolean(java.lang.String key,
                                    java.lang.Boolean defBoolean)
```
    指定したkeyに対応するデータを真偽値として取得する。
    keyに対応する型やデータが存在しない場合はdefBooleanを返す。
    
    パラメータ:
    
    key - 取得するデータのキー
    
    defBoolean - キーが存在しない場合の既定値
    
    戻り値:
    
    取得した値
  - put
```
public java.lang.Object put(java.lang.String key,
                            java.lang.Object value)
```
    指定された key に対応する value をオブジェクトに設定する。
    key にはピリオドを含むことはできない。また先頭に $ を含めることはできない。
    
    value に指定できるオブジェクトの型は、以下のいずれか。
    - Number
    - String
    - Boolean
    - Map<String,Object> - NbJSONObject を含む
    - List<Object> - NbJSONArray を含む
    Map, List に格納可能なオブジェクトの型も上記に準ずる。
    定義:
    
    put インタフェース内 java.util.Map<java.lang.String,java.lang.Object>
    
    パラメータ:
    
    key - 指定したvalueを識別するためのキー
    
    value - 指定したkeyに対応する値
  - remove
```
public java.lang.Object remove(java.lang.Object key)
```
    定義:
    
    remove インタフェース内 java.util.Map<java.lang.String,java.lang.Object>
  - putAll
```
public void putAll(java.util.Map<? extends java.lang.String,?> map)
```
    定義:
    
    putAll インタフェース内 java.util.Map<java.lang.String,java.lang.Object>
  - clear
```
public void clear()
```
    定義:
    
    clear インタフェース内 java.util.Map<java.lang.String,java.lang.Object>
  - putAcl
```
public void putAcl(NbAcl acl)
```
    指定されたACLをオブジェクトに設定する。
    
    パラメータ:
    
    acl - オブジェクトに設定するACL。
  - keySet
```
public java.util.Set<java.lang.String> keySet()
```
    オブジェクトに格納されたキーのSetを取得する。
    
    定義:
    
    keySet インタフェース内 java.util.Map<java.lang.String,java.lang.Object>
    
    戻り値:
    
    本クラスに格納されたキーのSet。
  - values
```
public java.util.Collection<java.lang.Object> values()
```
    定義:
    
    values インタフェース内 java.util.Map<java.lang.String,java.lang.Object>
  - entrySet
```
public java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>> entrySet()
```
    オブジェクトに格納されたキー・値の Entry Set を返す
    
    定義:
    
    entrySet インタフェース内 java.util.Map<java.lang.String,java.lang.Object>
    
    戻り値:
    
    本クラスに格納されたキー・値の Entry Set。
  - size
```
public int size()
```
    定義:
    
    size インタフェース内 java.util.Map<java.lang.String,java.lang.Object>
  - isEmpty
```
public boolean isEmpty()
```
    定義:
    
    isEmpty インタフェース内 java.util.Map<java.lang.String,java.lang.Object>
  - get
```
public java.lang.Object get(java.lang.Object key)
```
    定義:
    
    get インタフェース内 java.util.Map<java.lang.String,java.lang.Object>
  - containsKey
```
public boolean containsKey(java.lang.Object key)
```
    キーに対応する値（フィールド)が存在しているか判定する。なお、値が null の場合も存在していると判定する。
    
    定義:
    
    containsKey インタフェース内 java.util.Map<java.lang.String,java.lang.Object>
    
    パラメータ:
    
    key - キー
    
    戻り値:
    
    値が存在すれば true
  - containsValue
```
public boolean containsValue(java.lang.Object value)
```
    定義:
    
    containsValue インタフェース内 java.util.Map<java.lang.String,java.lang.Object>
  - isNull
```
public boolean isNull(java.lang.String key)
```
    キーに対応する値が null であるか、もしくは値が存在しないかを判定する
    
    パラメータ:
    
    key - キー
    
    戻り値:
    
    値が null もしくは値が存在しない場合は true
  - remove
```
public void remove(java.lang.String key)
```
    オブジェクトから指定された key のデータを削除する。
    
    パラメータ:
    
    key - 削除対象のkey
  - toJSONObject
```
public NbJSONObject toJSONObject()
```
    NbJSONObject に変換する
    
    戻り値:
    
    NbJSONObject
  - toJSONString
```
public java.lang.String toJSONString()
```
    JSON 文字列に変換する
    
    戻り値:
    
    JSON文字列
  - toString
```
public java.lang.String toString()
```
    オーバーライド:
    
    toString クラス内 java.lang.Object
  - getSyncState
```
public NbSyncState getSyncState()
```
    オブジェクトの同期状態を取得する。同期状態は NbSyncState で定義されている。レプリカモードのみ有効。
    
    戻り値:
    
    オブジェクトの同期状態
  - getLastSyncTime
```
public java.lang.String getLastSyncTime()
```
    オブジェクトの最終更新日時を取得する。レプリカモードのみ有効。
    
    戻り値:
    
    オブジェクトの最終更新日時
  - setCurrentParam
```
public void setCurrentParam(NbJSONObject map,
                            boolean isClear)
```
    内部インタフェース
  - getObjectData
```
public NbJSONObject getObjectData()
```
    オブジェクトに設定されたデータを NbJSONObject 形式で取得する。
    
    戻り値:
    
    オブジェクトに設定されたデータ
  - setImportance
```
public void setImportance(java.lang.String importance)
```
    指定されたImportanceをオブジェクトに設定する。
    
    パラメータ:
    
    importance - オブジェクトに設定するImportance。
  - resetImportance
```
public void resetImportance()
```
    オブジェクトに設定されたImportanceを解除する。
  - getImportance
```
public java.lang.String getImportance()
```
    オブジェクトに設定されたImportanceを取得する。
    
    戻り値:
    
    オブジェクトに設定されたImportance
  - isValidFieldName
```
public static boolean isValidFieldName(java.lang.String fieldName)
```
    フィールド名が正しいかチェックする。 nullチェック、使用可能文字チェックを行う。
    
    パラメータ:
    
    fieldName - フィールド名
    
    戻り値:
    
    使用可能であればtrue、使用不可であればfalse
  - getCreateTime
```
@Deprecated
public java.lang.String getCreateTime()
```
    非推奨です。 getCreatedTime() で置き換え
  - equals
```
public boolean equals(java.lang.Object o)
```
    定義:
    
    equals インタフェース内 java.util.Map<java.lang.String,java.lang.Object>
    
    オーバーライド:
    
    equals クラス内 java.lang.Object
  - hashCode
```
public int hashCode()
```
    定義:
    
    hashCode インタフェース内 java.util.Map<java.lang.String,java.lang.Object>
    
    オーバーライド:
    
    hashCode クラス内 java.lang.Object
  - getObjectId
```
public java.lang.String getObjectId()
```
    サーバから割り当てられたオブジェクトID。
  - setObjectId
```
public NbObject setObjectId(java.lang.String mObjectId)
```
    サーバから割り当てられたオブジェクトID。
    
    戻り値:
    
    this
  - getCreatedTime
```
public java.lang.String getCreatedTime()
```
    オブジェクトの作成日時。この値は、サーバで割り当てられたものである。
  - setCreatedTime
```
public NbObject setCreatedTime(java.lang.String mCreatedTime)
```
    オブジェクトの作成日時。この値は、サーバで割り当てられたものである。
    
    戻り値:
    
    this
  - getUpdatedTime
```
public java.lang.String getUpdatedTime()
```
    オブジェクトの更新日時。この値は、サーバで割り当てられたものである。
  - setUpdatedTime
```
public NbObject setUpdatedTime(java.lang.String mUpdatedTime)
```
    オブジェクトの更新日時。この値は、サーバで割り当てられたものである。
    
    戻り値:
    
    this
  - getBucketName
```
public java.lang.String getBucketName()
```
    バケット名
  - setBucketName
```
public NbObject setBucketName(java.lang.String mBucketName)
```
    バケット名
    
    戻り値:
    
    this
  - getETag
```
public java.lang.String getETag()
```
    ETag
  - setETag
```
public NbObject setETag(java.lang.String mETag)
```
    ETag
    
    戻り値:
    
    this
  - getMode
```
public NbBucketMode getMode()
```
    オブジェクトのモードを取得する。
  - getAcl
```
public NbAcl getAcl()
```
    オブジェクトに設定されたACL。
  - setAcl
```
public NbObject setAcl(NbAcl mAcl)
```
    オブジェクトに設定されたACL。
    
    戻り値:
    
    this

クラス NbObject

ネストされたクラスのサマリー

インタフェースから継承されたネストされたクラス/インタフェース java.util.Map

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

インタフェースから継承されたメソッド java.util.Map

コンストラクタの詳細

NbObject

NbObject

NbObject

NbObject

メソッドの詳細

_setJsonObject

_getService

save

save

partUpdateObject

partUpdateObject

partUpdateObject

deleteObject

deleteObject

getString

getNumber

getAny

getJSONObject

getJSONArray

getBoolean

put

remove

putAll

clear

putAcl

keySet

values

entrySet

size

isEmpty

get

containsKey

containsValue

isNull

remove

toJSONObject

toJSONString

toString

getSyncState

getLastSyncTime

setCurrentParam

getObjectData

setImportance

resetImportance

getImportance

isValidFieldName

getCreateTime

equals

hashCode

getObjectId

setObjectId

getCreatedTime

setCreatedTime

getUpdatedTime

setUpdatedTime

getBucketName

setBucketName

getETag

setETag

getMode

getAcl

setAcl