この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

Partition クラス

Cache.OrgPartition および Cache.SessionPartition の基本クラス。サブクラスを使用して、組織キャッシュとセッションキャッシュのキャッシュパーティションを管理します。

名前空間

キャッシュ

パーティションメソッドのキャッシュキー形式

パーティションオブジェクト (Cache.OrgPartition または Cache.SessionPartition のインスタンス) を取得した後、パーティション内のキャッシュ値を追加、取得、および管理するメソッドがそのキー名を取得します。これらのメソッド (get()put()remove()contains()) にユーザが指定するキー名には namespace.partition プレフィックスが含まれていません。

Partition メソッド

Partition のメソッドは次のとおりです。

contains(key)

キャッシュパーティションに指定したキーに対応するキャッシュ値が含まれる場合は true を返します。

署名

public Boolean contains(String key)

パラメータ

key
型: String
キャッシュ値を一意に識別する文字列値 (大文字と小文字を区別)。

戻り値

型: Boolean

キャッシュエントリが見つかった場合は、true。それ以外の場合は、false

createFullyQualifiedKey(namespace, partition, key)

渡された主要コンポーネントから完全修飾キーを生成します。生成されるキー文字列の形式は namespace.partition.key です。

署名

public static String createFullyQualifiedKey(String namespace, String partition, String key)

パラメータ

namespace
型: String
キャッシュキーの名前空間。
partition
型: String
キャッシュキーのパーティション。
key
型: String
キャッシュキーの名前。

戻り値

型: String

createFullyQualifiedPartition(namespace, partition)

渡された名前空間とパーティションから完全修飾パーティション名を生成します。生成されるパーティション文字列の形式は namespace.partition です。

署名

public static String createFullyQualifiedPartition(String namespace, String partition)

パラメータ

namespace
型: String
キャッシュキーの名前空間。
partition
型: String
キャッシュキーのパーティション。

戻り値

型: String

get(key)

キャッシュパーティションから、指定したキーに対応するキャッシュ値を返します。

署名

public Object get(String key)

パラメータ

key
型: String
キャッシュ値を一意に識別する文字列値 (大文字と小文字を区別)。

戻り値

型: Object

キャッシュ値が汎用オブジェクト種別として返されます。戻り値を適切な型にキャストしてください。

getCapacity()

このパーティションの総容量に占めるキャッシュの使用率を返します。

署名

public Double getCapacity()

戻り値

型: Double

パーティションキャッシュの使用率をパーセント値で返します。

getKeys()

キャッシュパーティションに保存され、かつ呼び出し名前空間から参照可能なすべてのキーをまとめて返します。

署名

public Set<String> getKeys()

戻り値

型: Set<String>

すべてのキャッシュキーのセット。

getName()

このキャッシュパーティションの名前を返します。

署名

public String getName()

戻り値

型: String

このキャッシュパーティションの名前。

isAvailable()

Salesforce セッションが使用できる場合に true を返します。Cache.SessionPartition にのみ適用されます。

署名

public Boolean isAvailable()

戻り値

型: Boolean

put(key, value)

特定のキー/値ペアをキャッシュされたエントリとしてキャッシュパーティションに保存します。put メソッドは、組織の名前空間のキャッシュにのみ書き込むことができます。

署名

public void put(String key, Object value)

パラメータ

key
型: String
キャッシュ値を一意に識別する文字列値 (大文字と小文字を区別)。
value
型: Object
キャッシュに保存する値。キャッシュ値は逐次化可能にする必要があります。

戻り値

型: void

put(key, value, visibility)

特定のキー/値ペアをキャッシュされたエントリとしてキャッシュパーティションに保存し、キャッシュ値の表示を設定します。

署名

public void put(String key, Object value, cache.Visibility visibility)

パラメータ

key
型: String
キャッシュ値を一意に識別する文字列値 (大文字と小文字を区別)。
value
型: Object
キャッシュに保存する値。キャッシュ値は逐次化可能にする必要があります。
visibility
型: Cache.Visibility
キャッシュ値を使用できるのが、同じ名前空間内で実行される Apex コードのみか、任意の名前空間から実行される Apex コードかを示します。

戻り値

型: void

put(key, value, ttlSecs)

特定のキー/値ペアをキャッシュされたエントリとしてキャッシュパーティションに保存し、キャッシュ値の有効期限を設定します。

署名

public void put(String key, Object value, Integer ttlSecs)

パラメータ

key
型: String
キャッシュ値を一意に識別する文字列値 (大文字と小文字を区別)。
value
型: Object
キャッシュに保存する値。キャッシュ値は逐次化可能にする必要があります。
ttlSecs
型: Integer
キャッシュ値をキャッシュに保持しておく時間 (秒数)。最大値は 28,800 秒 (8 時間) です。最小値は 300 秒 (5 分) です。

戻り値

型: void

put(key, value, ttlSecs, visibility, immutable)

特定のキー/値ペアをキャッシュされたエントリとしてキャッシュパーティションに保存します。このメソッドはまた、キャッシュ値の有効期限、表示、および別の名前空間で上書きされるかどうかを設定します。

署名

public void put(String key, Object value, Integer ttlSecs, cache.Visibility visibility, Boolean immutable)

パラメータ

key
型: String
キャッシュ値を一意に識別する文字列値 (大文字と小文字を区別)。
value
型: Object
キャッシュに保存する値。キャッシュ値は逐次化可能にする必要があります。
ttlSecs
型: Integer
キャッシュ値をキャッシュに保持しておく時間 (秒数)。最大値は 28,800 秒 (8 時間) です。最小値は 300 秒 (5 分) です。
visibility
型: Cache.Visibility
キャッシュ値を使用できるのが、同じ名前空間内で実行される Apex コードのみか、任意の名前空間から実行される Apex コードかを示します。
immutable
型: Boolean
キャッシュ値を別の名前空間によって上書きできるか (false)、否か (true) を示します。

戻り値

型: void

remove(key)

このキャッシュパーティションから、指定したキーに対応するキャッシュ値を削除します。

署名

public Boolean remove(String key)

パラメータ

key
型: String
キャッシュ値を一意に識別する文字列値 (大文字と小文字を区別)。

戻り値

型: Boolean

キャッシュ値が正常に削除された場合は true。それ以外の場合は、false

validateKey(isDefault, key)

キャッシュキーを検証します。キーが無効の場合は Cache.InvalidParamException が発生します。有効なキーは null でなく、英数字で構成されています。

署名

public static void validateKey(Boolean isDefault, String key)

パラメータ

isDefault
型: Boolean
キーがデフォルトパーティションを参照する場合は、true に設定します。それ以外の場合は、false に設定します。
key
型: String
検証するキー。

戻り値

型: void

validateKeyValue(isDefault, key, value)

キャッシュキーを検証して、キャッシュ値が null 以外であることを確認します。キーまたは値が無効の場合は、Cache.InvalidParamException が発生します。有効なキーは null でなく、英数字で構成されています。

署名

public static void validateKeyValue(Boolean isDefault, String key, Object value)

パラメータ

isDefault
型: Boolean
キーがデフォルトパーティションを参照する場合は、true に設定します。それ以外の場合は、false に設定します。
key
型: String
検証するキー。
value
型: Object
検証するキャッシュ値。

戻り値

型: void

validateKeys(isDefault, keys)

指定したキャッシュキーを検証します。キーが無効の場合は Cache.InvalidParamException が発生します。有効なキーは null でなく、英数字で構成されています。

署名

public static void validateKeys(Boolean isDefault, Set<String> keys)

パラメータ

isDefault
型: Boolean
キーがデフォルトパーティションを参照する場合は、true に設定します。それ以外の場合は、false に設定します。
keys
型: Set<String>
検証するキー文字列値のセット。

戻り値

型: void

validatePartitionName(name)

パーティション名を検証します (名前が null でないことなど)。

署名

public static void validatePartitionName(String name)

パラメータ

name
型: String
検証するパーティションの名前。

戻り値

型: void