Class GroupsSelector


  • public final class GroupsSelector
    extends java.lang.Object
    Argument for selecting a list of groups, either by group_ids, or external group IDs.

    This class is a 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.

    • Method Detail

      • tag

        public GroupsSelector.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 GroupsSelector.

        Returns:
        the tag for this instance.
      • groupIds

        public static GroupsSelector groupIds​(java.util.List<java.lang.String> value)
        Returns an instance of GroupsSelector that has its tag set to GroupsSelector.Tag.GROUP_IDS.

        List of group IDs.

        Parameters:
        value - value to assign to this instance.
        Returns:
        Instance of GroupsSelector with its tag set to GroupsSelector.Tag.GROUP_IDS.
        Throws:
        java.lang.IllegalArgumentException - if value contains a null item or is null.
      • getGroupIdsValue

        public java.util.List<java.lang.String> getGroupIdsValue()
        List of group IDs.

        This instance must be tagged as GroupsSelector.Tag.GROUP_IDS.

        Returns:
        The List value associated with this instance if isGroupIds() is true.
        Throws:
        java.lang.IllegalStateException - If isGroupIds() is false.
      • groupExternalIds

        public static GroupsSelector groupExternalIds​(java.util.List<java.lang.String> value)
        Returns an instance of GroupsSelector that has its tag set to GroupsSelector.Tag.GROUP_EXTERNAL_IDS.

        List of external IDs of groups.

        Parameters:
        value - value to assign to this instance.
        Returns:
        Instance of GroupsSelector with its tag set to GroupsSelector.Tag.GROUP_EXTERNAL_IDS.
        Throws:
        java.lang.IllegalArgumentException - if value contains a null item or is 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