パッケージ org.wcardinal.controller.data

クラス SMap<V>

java.lang.Object
org.wcardinal.controller.data.SMap<V>
型パラメータ:
V - value type
すべての実装されたインタフェース:
Map<String,V>, SLockable, SVariable, Unlockable
直系の既知のサブクラス:
SMapImpl, SNavigableMap
public abstract class SMap<V> extends Object implements SLockable, SVariable, Map<String,V>
Represents the map data. The key type is the string and must not be null. The class V can be any class. However, for synchronization, the class V must be serializable to, and deserializable from JSON by the Jackson.

  • コンストラクタの詳細

    • SMap

      public SMap()

  • メソッドの詳細

    • replace

      public abstract void replace(Iterable<? extends V> values)
      Constructs a map from the specified iterable and replaces the existing mappings with the specified mappings if the existing mappings are not equal to the specified mappings. For testing the equality of mappings, V#equals(Object) is used. As a key, a field or a method annotated with javax.persistence.Id is used.
      パラメータ:
      values - new values
      例外:
      NullPointerException - if the specified iterable is null
      IllegalStateException - if this navigable map is not initialized properly

    • replace

      public abstract void replace(Iterable<? extends V> values, SKeyOf<V> keyOf)
      Constructs a map from the specified iterable and replaces the existing mappings with the specified mappings if the existing mappings are not equal to the specified mappings. For testing the equality of mappings, V#equals(Object) is used. As a key, the return value of SKeyOf.keyOf(Object) is used.
      パラメータ:
      values - new values
      keyOf - function object for retrieving keys from values
      例外:
      NullPointerException - if the specified iterable or keyOf is null

    • replace

      public abstract void replace(Map<String,? extends V> mappings)
      Replaces the existing mappings with the specified mappings if the existing mappings are not equal to the specified mappings. For testing the equality of mappings, V#equals(Object) is used.
      パラメータ:
      mappings - new mappings
      例外:
      NullPointerException - if the specified map is null

    • toDirty

      @ThreadSafe public abstract void toDirty(String key)
      Marks the value of the specified key as updated.
      パラメータ:
      key - key of the value to be marked as updated

    • toDirty

      @ThreadSafe public abstract void toDirty()
      Marks all the values as updated.

    • clearAndPut

      public abstract V clearAndPut(String key, V value)
      Clear this map and then associates the specified value with the specified key in this map.
      パラメータ:
      key - key with which the specified value is to be associated
      value - value to be associated with the specified key
      戻り値:
      null
      例外:
      NullPointerException - if this map does not permit null keys or value, and the specified key or value is null

    • clearAndPutAll

      public abstract void clearAndPutAll(Map<? extends String,? extends V> mappings)
      Clear this map and then copies all of the mappings from the specified map to this map.
      パラメータ:
      mappings - mappings to be copied to this map
      例外:
      NullPointerException - if the specified map is null, or if this map does not permit null keys or value, and the specified map contains null keys or values

    • reput

      public abstract V reput(String key)
      Reassociate the value of the specified key.
      パラメータ:
      key - the key which is to be reassociated.
      戻り値:
      the value of the specified key.
      例外:
      NullPointerException - if this map does not permit null keys, and the specified key is null