Package com.dropbox.core.v2.common

Class UserRootInfo

java.lang.Object
com.dropbox.core.v2.common.RootInfo
com.dropbox.core.v2.common.UserRootInfo
public class UserRootInfo extends RootInfo
Root info when user is not member of a team or the user is a member of a team and the team does not have a separate root namespace.

  • Field Details

    • homePath

      @Nullable protected final String homePath

  • Constructor Details

    • UserRootInfo

      public UserRootInfo(@Nonnull String rootNamespaceId, @Nonnull String homeNamespaceId, @Nullable String homePath)
      Root info when user is not member of a team or the user is a member of a team and the team does not have a separate root namespace.
      Parameters:
      rootNamespaceId - The namespace ID for user's root namespace. It will be the namespace ID of the shared team root if the user is member of a team with a separate team root, or the user root if user is member of a team with separate distinct roots for users. Otherwise it will be the same as RootInfo.getHomeNamespaceId(). Must match pattern "[-_0-9a-zA-Z:]+" and not be null.
      homeNamespaceId - The namespace ID for user's home namespace. Must match pattern "[-_0-9a-zA-Z:]+" and not be null.
      homePath - The path for user's home directory under the distinct user root.
      Throws:
      IllegalArgumentException - If any argument does not meet its preconditions.

    • UserRootInfo

      public UserRootInfo(@Nonnull String rootNamespaceId, @Nonnull String homeNamespaceId)
      Root info when user is not member of a team or the user is a member of a team and the team does not have a separate root namespace.

      The default values for unset fields will be used.

      Parameters:
      rootNamespaceId - The namespace ID for user's root namespace. It will be the namespace ID of the shared team root if the user is member of a team with a separate team root, or the user root if user is member of a team with separate distinct roots for users. Otherwise it will be the same as RootInfo.getHomeNamespaceId(). Must match pattern "[-_0-9a-zA-Z:]+" and not be null.
      homeNamespaceId - The namespace ID for user's home namespace. Must match pattern "[-_0-9a-zA-Z:]+" and not be null.
      Throws:
      IllegalArgumentException - If any argument does not meet its preconditions.

  • Method Details

    • getRootNamespaceId

      @Nonnull public String getRootNamespaceId()
      The namespace ID for user's root namespace. It will be the namespace ID of the shared team root if the user is member of a team with a separate team root, or the user root if user is member of a team with separate distinct roots for users. Otherwise it will be the same as RootInfo.getHomeNamespaceId().
      Overrides:
      getRootNamespaceId in class RootInfo
      Returns:
      value for this field, never null.

    • getHomeNamespaceId

      @Nonnull public String getHomeNamespaceId()
      The namespace ID for user's home namespace.
      Overrides:
      getHomeNamespaceId in class RootInfo
      Returns:
      value for this field, never null.

    • getHomePath

      @Nullable public String getHomePath()
      The path for user's home directory under the distinct user root.
      Returns:
      value for this field, or null if not present.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class RootInfo

    • equals

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

    • toString

      public String toString()
      Overrides:
      toString in class RootInfo

    • toStringMultiline

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

      The returned String may contain newlines.

      Overrides:
      toStringMultiline in class RootInfo
      Returns:
      Formatted, multiline String representation of this object