Module swim.io
Package swim.io

Enum Class FlowModifier

java.lang.Object
java.lang.Enum<FlowModifier>
swim.io.FlowModifier
All Implemented Interfaces:
Serializable, Comparable<FlowModifier>, Constable, Debug
public enum FlowModifier extends Enum<FlowModifier> implements Debug
Network channel flow delta, modifying read and write operations. Represents an atomic change to a FlowControl state.
See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    DISABLE_READ
    read operation should be disabled; write operation should not be modified.
    DISABLE_READ_ENABLE_WRITE
    read operation should be disabled; write operation should be enabled.
    DISABLE_READ_WRITE
    read and write operations should be disabled.
    DISABLE_WRITE
    write operation should be disabled; read operation should not be modified.
    DISABLE_WRITE_ENABLE_READ
    write operation should be disabled; read operation should be enabled.
    ENABLE_READ
    read operation should be enabled; write operation should not be modified.
    ENABLE_READ_WRITE
    read and write operations should be enabled.
    ENABLE_WRITE
    write operation should be enabled; read operation should not be modified.
    RESELECT
    read and write operations should not be modified.

  • Method Summary

    Modifier and Type
    Method
    Description
    FlowModifier
    and(FlowModifier that)
    Returns the FlowModifier with all modifications applied in this and that applied, with enable instructions taking precedence over conflicting disable instructions.
    <T> Output<T>
    debug(Output<T> output)
    Writes a developer readable, debug-formatted string representation of this object to output.
    boolean
    isReadDisabled()
    Returns true if the read operation should be disabled.
    boolean
    isReadEnabled()
    Returns true if the read operation should be enabled.
    boolean
    isWriteDisabled()
    Returns true if the write operation should be disabled.
    boolean
    isWriteEnabled()
    Returns true if the write operation should be enabled.
    FlowModifier
    not()
    Returns the FlowModifier with all applied modifications in this unapplied, and all unapplied operations in this applied, with enable instructions taking precedence over conflicting disable instructions.
    FlowModifier
    or(FlowModifier that)
    Returns the FlowModifier with all modifications applied in this or that applied, with enable instructions taking precedence over conflicting disable instructions.
    static FlowModifier
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static FlowModifier[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.
    FlowModifier
    xor(FlowModifier that)
    Returns the FlowModifier with all modifications applied in this or that—but not both—applied, with enable instructions taking precedence over conflicting disable instructions.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • RESELECT

      public static final FlowModifier RESELECT
      read and write operations should not be modified.

    • DISABLE_READ

      public static final FlowModifier DISABLE_READ
      read operation should be disabled; write operation should not be modified.

    • DISABLE_WRITE

      public static final FlowModifier DISABLE_WRITE
      write operation should be disabled; read operation should not be modified.

    • DISABLE_READ_WRITE

      public static final FlowModifier DISABLE_READ_WRITE
      read and write operations should be disabled.

    • ENABLE_READ

      public static final FlowModifier ENABLE_READ
      read operation should be enabled; write operation should not be modified.

    • DISABLE_WRITE_ENABLE_READ

      public static final FlowModifier DISABLE_WRITE_ENABLE_READ
      write operation should be disabled; read operation should be enabled.

    • ENABLE_WRITE

      public static final FlowModifier ENABLE_WRITE
      write operation should be enabled; read operation should not be modified.

    • DISABLE_READ_ENABLE_WRITE

      public static final FlowModifier DISABLE_READ_ENABLE_WRITE
      read operation should be disabled; write operation should be enabled.

    • ENABLE_READ_WRITE

      public static final FlowModifier ENABLE_READ_WRITE
      read and write operations should be enabled.

  • Method Details

    • values

      public static FlowModifier[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static FlowModifier valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null

    • isReadDisabled

      public boolean isReadDisabled()
      Returns true if the read operation should be disabled.

    • isWriteDisabled

      public boolean isWriteDisabled()
      Returns true if the write operation should be disabled.

    • isReadEnabled

      public boolean isReadEnabled()
      Returns true if the read operation should be enabled.

    • isWriteEnabled

      public boolean isWriteEnabled()
      Returns true if the write operation should be enabled.

    • or

      public FlowModifier or(FlowModifier that)
      Returns the FlowModifier with all modifications applied in this or that applied, with enable instructions taking precedence over conflicting disable instructions.

    • xor

      public FlowModifier xor(FlowModifier that)
      Returns the FlowModifier with all modifications applied in this or that—but not both—applied, with enable instructions taking precedence over conflicting disable instructions.

    • and

      public FlowModifier and(FlowModifier that)
      Returns the FlowModifier with all modifications applied in this and that applied, with enable instructions taking precedence over conflicting disable instructions.

    • not

      public FlowModifier not()
      Returns the FlowModifier with all applied modifications in this unapplied, and all unapplied operations in this applied, with enable instructions taking precedence over conflicting disable instructions.

    • debug

      public <T> Output<T> debug(Output<T> output)
      Description copied from interface: Debug
      Writes a developer readable, debug-formatted string representation of this object to output.
      Specified by:
      debug in interface Debug
      Returns:
      the continuation of the output.