Package com.alachisoft.ncache.client

Enum StreamMode

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<StreamMode>
    public enum StreamMode
extends java.lang.Enum<StreamMode>
    Specifies the modes of CacheStream.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      Read
      Choose this mode for read-only access to the stream by acquiring reader lock.
      ReadWithoutLock
      Choose this mode for read-only access to the stream without acquiring reader lock.
      Write
      Choose this mode for write access to the stream.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static StreamMode forValue​(int value)
      Retreives the enum constant of the specified value, if exists.
      int getValue()
      Order is important in enums.
      static StreamMode valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static StreamMode[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • Read

        public static final StreamMode Read
        Choose this mode for read-only access to the stream by acquiring reader lock.

      • ReadWithoutLock

        public static final StreamMode ReadWithoutLock
        Choose this mode for read-only access to the stream without acquiring reader lock.

      • Write

        public static final StreamMode Write
        Choose this mode for write access to the stream.

    • Method Detail

      • values

        public static StreamMode[] 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 (StreamMode c : StreamMode.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static StreamMode valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • forValue

        public static StreamMode forValue​(int value)
        Retreives the enum constant of the specified value, if exists.
        Parameters:
        value - Enum constant index.
        Returns:
        Enum constant.

      • getValue

        public int getValue()
        Order is important in enums. By using getValue() method, each enum constant index can be found, just like array index.
        Returns:
        Enum constant index.