Package com.dropbox.core.v2.users

Class FileLockingValue

java.lang.Object
com.dropbox.core.v2.users.FileLockingValue
public final class FileLockingValue extends Object
The value for UserFeature.FILE_LOCKING.

This class is an open tagged union. Tagged unions instances are always associated to a specific tag. This means only one of the isAbc() methods will return true. You can use tag() to determine the tag associated with this instance.

Open unions may be extended in the future with additional tags. If a new tag is introduced that this SDK does not recognized, the OTHER value will be used.

  • Field Details

    • OTHER

      public static final FileLockingValue OTHER
      Catch-all used for unknown tag values returned by the Dropbox servers.

      Receiving a catch-all value typically indicates this SDK version is not up to date. Consider updating your SDK version to handle the new tags.

  • Method Details

    • tag

      public FileLockingValue.Tag tag()
      Returns the tag for this instance.

      This class is a tagged union. Tagged unions instances are always associated to a specific tag. This means only one of the isXyz() methods will return true. Callers are recommended to use the tag value in a switch statement to properly handle the different values for this FileLockingValue.

      If a tag returned by the server is unrecognized by this SDK, the FileLockingValue.Tag.OTHER value will be used.

      Returns:
      the tag for this instance.

    • isEnabled

      public boolean isEnabled()
      Returns true if this instance has the tag FileLockingValue.Tag.ENABLED, false otherwise.
      Returns:
      true if this instance is tagged as FileLockingValue.Tag.ENABLED, false otherwise.

    • enabled

      public static FileLockingValue enabled(boolean value)
      Returns an instance of FileLockingValue that has its tag set to FileLockingValue.Tag.ENABLED.

      When this value is True, the user can lock files in shared directories. When the value is False the user can unlock the files they have locked or request to unlock files locked by others.

      Parameters:
      value - value to assign to this instance.
      Returns:
      Instance of FileLockingValue with its tag set to FileLockingValue.Tag.ENABLED.

    • getEnabledValue

      public boolean getEnabledValue()
      When this value is True, the user can lock files in shared directories. When the value is False the user can unlock the files they have locked or request to unlock files locked by others.

      This instance must be tagged as FileLockingValue.Tag.ENABLED.

      Returns:
      The
      invalid reference 
      boolean
      value associated with this instance if isEnabled() is true.
      Throws:
      IllegalStateException - If isEnabled() is false.

    • isOther

      public boolean isOther()
      Returns true if this instance has the tag FileLockingValue.Tag.OTHER, false otherwise.
      Returns:
      true if this instance is tagged as FileLockingValue.Tag.OTHER, false otherwise.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toStringMultiline

      public String toStringMultiline()
      Returns a String representation of this object formatted for easier readability.

      The returned String may contain newlines.

      Returns:
      Formatted, multiline String representation of this object