Enum ReplicatedStorage.LookupFlag

  • All Implemented Interfaces:
    Serializable, Comparable<ReplicatedStorage.LookupFlag>
    Enclosing interface:
    ReplicatedStorage

    public static enum ReplicatedStorage.LookupFlag
    extends Enum<ReplicatedStorage.LookupFlag>

    Optional flags that can be used to affect state lookup behaviour in a ReplicatedStorage.retrieve(Key, EnumSet) operation.

    These flags are only useful to use when storage is "replicated" to an external database or other remote system via the likes of a key/value store. They are not meaningful when using savanna-replicating storage as replicated state there is always local and a concept of remote state does not exist. Attempting to suppress a local find, for example, when using savanna replication will result in state never being found.

    Since:
    Rhino 2.7.0
    • Enum Constant Detail

      • SUPPRESS_LOCAL_FIND

        public static final ReplicatedStorage.LookupFlag SUPPRESS_LOCAL_FIND

        Flag that suppresses the examination of locally held state during the operation.

        Since:
        Rhino 2.7.0
      • SUPPRESS_REMOTE_FIND

        public static final ReplicatedStorage.LookupFlag SUPPRESS_REMOTE_FIND

        Flag that suppresses the querying of externally held state, for example by a key/value store, during the operation.

        Since:
        Rhino 2.7.0
      • SUPPRESS_LOCAL_INSERT

        public static final ReplicatedStorage.LookupFlag SUPPRESS_LOCAL_INSERT

        Flag that suppresses the insertion of externally retrieved state into local state during the operation.

        This flag allows a client to retrieve and inspect externally stored state without the node becoming an owner of that state.

        Since:
        Rhino 2.7.0
    • Method Detail

      • values

        public static ReplicatedStorage.LookupFlag[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (ReplicatedStorage.LookupFlag c : ReplicatedStorage.LookupFlag.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static ReplicatedStorage.LookupFlag valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null