Package com.j_spaces.core.client

Class UpdateModifiers

java.lang.Object
com.j_spaces.core.client.UpdateModifiers
public class UpdateModifiers extends Object
The Modifier class provides static methods and constants to decode update types modifiers. The sets of modifiers are represented as integers with distinct bit positions representing different modifiers.
Version:
4.0
Author:
Yechiel Fefer, Igor Goldenberg

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    MEMORY_ONLY_SEARCH
    Look only in memory for existence of entry with the same ID -do not use the underlying EDS.
    static final int
    NO_RETURN_VALUE
    If set, the write or update operations will return null instead of the lease object (write) or previous value (update).
    static final int
    PARTIAL_UPDATE
    The int value representing the PARTIAL_UPDATE modifier.
    static final int
    RETURN_PREV_ON_UPDATE
    Determines if an update operation should return the previous entry in the lease.
    static final int
    UPDATE_ONLY
    The int value representing the UPDATE_OR_ONLY modifier.
    static final int
    UPDATE_OR_WRITE
    The int value representing the UPDATE_OR_WRITE modifier.
    static final int
    WRITE_ONLY
    The int value representing the WRITE_ONLY modifier.

  • Constructor Summary

    Constructors
    Constructor
    Description
    UpdateModifiers()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static boolean
    isMemoryOnlySearch(int mod)
    Return true if the integer argument includes the MEMORY_ONLY_SEARCH modifier, false otherwise.
    static boolean
    isNoReturnValue(int mod)
    Return true if the integer argument includes the NO_RETURN_VALUE modifier, false otherwise.
    static boolean
    isPartialUpdate(int mod)
    Return true if the integer argument includes the PARTIAL_UPDATE modifier, false otherwise.
    static boolean
    isPotentialUpdate(int mod)
     
    static boolean
    isReturnPrevOnUpdate(int mod)
    Return true if the integer argument includes the RETURN_PREV_ON_UPDATE modifier, false otherwise.
    static boolean
    isUpdate(int mod)
    Return true if the integer argument includes the UPDATE_ONLY modifier or PARTIAL_UPDATE modifier or UPDATE_OR_WRITE modifier, false otherwise.
    static boolean
    isUpdateOnly(int mod)
    Return true if the integer argument includes the UPDATE_ONLY modifier, false otherwise.
    static boolean
    isUpdateOrWrite(int mod)
    Return true if the integer argument includes the UPDATE_OR_WRITE modifier, false otherwise.
    static boolean
    isWriteOnly(int mod)
    Return true if the integer argument includes the WRITE_ONLY modifier, false otherwise.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • WRITE_ONLY

      public static final int WRITE_ONLY
      The int value representing the WRITE_ONLY modifier. When set: the entry to be written must not reside in the space, no new entry will be written otherwise and an EntryAlreadyInSpaceException will be thrown. Notice: can't be used in together with UPDATE_OR_WRITE or UPDATE_ONLY.
      See Also:

    • UPDATE_ONLY

      public static final int UPDATE_ONLY
      The int value representing the UPDATE_OR_ONLY modifier. When set alone: the entry to be updated must be reside in the space, no new entry will be written otherwise and an EntryNotInSpaceException will be thrown.
      See Also:

    • UPDATE_OR_WRITE

      public static final int UPDATE_OR_WRITE
      The int value representing the UPDATE_OR_WRITE modifier. When set: if the entry to be updated does not reside in the space, a new entry is written

      Notice: can't be used in together with PARTIAL_UPDATE

      See Also:

    • PARTIAL_UPDATE

      public static final int PARTIAL_UPDATE
      The int value representing the PARTIAL_UPDATE modifier. If set, null values in the updated entry are treated as "leave as it is"

      Notice: can't be used in together with UPDATE_OR_WRITE or WRITE_ONLY.

      See Also:

    • NO_RETURN_VALUE

      public static final int NO_RETURN_VALUE
      If set, the write or update operations will return null instead of the lease object (write) or previous value (update). Using this option will improve application write operation performance - null return value yields less network traffic and less memory consumption. Note: This modifier does not replace ONE_WAY modifier
      See Also:

    • RETURN_PREV_ON_UPDATE

      public static final int RETURN_PREV_ON_UPDATE
      Determines if an update operation should return the previous entry in the lease.
      Since:
      9.0.1
      See Also:

  • Constructor Details

    • UpdateModifiers

      public UpdateModifiers()

  • Method Details

    • isUpdateOrWrite

      public static boolean isUpdateOrWrite(int mod)
      Return true if the integer argument includes the UPDATE_OR_WRITE modifier, false otherwise.
      Parameters:
      mod - a set of modifiers
      Returns:
      true if mod includes the public modifier; false otherwise.

    • isPartialUpdate

      public static boolean isPartialUpdate(int mod)
      Return true if the integer argument includes the PARTIAL_UPDATE modifier, false otherwise.
      Parameters:
      mod - a set of modifiers
      Returns:
      true if mod includes the PARTIAL_UPDATE modifier; false otherwise.

    • isUpdateOnly

      public static boolean isUpdateOnly(int mod)
      Return true if the integer argument includes the UPDATE_ONLY modifier, false otherwise.
      Parameters:
      mod - a set of modifiers
      Returns:
      true if mod includes the UPDATE_ONLY modifier; false otherwise.

    • isUpdate

      public static boolean isUpdate(int mod)
      Return true if the integer argument includes the UPDATE_ONLY modifier or PARTIAL_UPDATE modifier or UPDATE_OR_WRITE modifier, false otherwise.
      Parameters:
      mod - a set of modifiers
      Returns:
      true if mod includes the UPDATE_ONLY modifier or PARTIAL_UPDATE modifier or UPDATE_OR_WRITE modifier; false otherwise.

    • isWriteOnly

      public static boolean isWriteOnly(int mod)
      Return true if the integer argument includes the WRITE_ONLY modifier, false otherwise.
      Parameters:
      mod - a set of modifiers
      Returns:
      true if mod includes the WRITE_ONLY modifier; false otherwise.

    • isNoReturnValue

      public static boolean isNoReturnValue(int mod)
      Return true if the integer argument includes the NO_RETURN_VALUE modifier, false otherwise.
      Parameters:
      mod - a set of modifiers
      Returns:
      true if mod includes the NO_RETURN_VALUE modifier; false otherwise.

    • isReturnPrevOnUpdate

      public static boolean isReturnPrevOnUpdate(int mod)
      Return true if the integer argument includes the RETURN_PREV_ON_UPDATE modifier, false otherwise.
      Parameters:
      mod - a set of modifiers
      Returns:
      true if mod includes the RETURN_PREV_ON_UPDATE modifier; false otherwise.

    • isMemoryOnlySearch

      public static boolean isMemoryOnlySearch(int mod)
      Return true if the integer argument includes the MEMORY_ONLY_SEARCH modifier, false otherwise.
      Parameters:
      mod - a set of modifiers
      Returns:
      true if mod includes the MEMORY_ONLY_SEARCH modifier; false otherwise.

    • isPotentialUpdate

      public static boolean isPotentialUpdate(int mod)