Class RootInfo

  • Direct Known Subclasses:
    TeamRootInfo, UserRootInfo

    public class RootInfo
    extends java.lang.Object
    Information about current user's root.
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  RootInfo.Serializer
      For internal use only.
    • Constructor Summary

      Constructors 
      Constructor Description
      RootInfo​(java.lang.String rootNamespaceId, java.lang.String homeNamespaceId)
      Information about current user's root.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      java.lang.String getHomeNamespaceId()
      The namespace ID for user's home namespace.
      java.lang.String getRootNamespaceId()
      The namespace ID for user's root namespace.
      int hashCode()  
      java.lang.String toString()  
      java.lang.String toStringMultiline()
      Returns a String representation of this object formatted for easier readability.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Field Detail

      • rootNamespaceId

        @Nonnull
        protected final java.lang.String rootNamespaceId
      • homeNamespaceId

        @Nonnull
        protected final java.lang.String homeNamespaceId
    • Constructor Detail

      • RootInfo

        public RootInfo​(@Nonnull
                        java.lang.String rootNamespaceId,
                        @Nonnull
                        java.lang.String homeNamespaceId)
        Information about current user's root.
        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. Otherwise it will be same as 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:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
    • Method Detail

      • getRootNamespaceId

        @Nonnull
        public java.lang.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. Otherwise it will be same as getHomeNamespaceId().
        Returns:
        value for this field, never null.
      • getHomeNamespaceId

        @Nonnull
        public java.lang.String getHomeNamespaceId()
        The namespace ID for user's home namespace.
        Returns:
        value for this field, never null.
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • toStringMultiline

        public java.lang.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