Interface Group

    • Method Detail

      • getName

        @NonNull String getName()
        Get the name of the group
        Returns:
        the name of the group
      • getDisplayName

        @Nullable String getDisplayName()
        Gets the groups "display name", if it has one that differs from it's actual name.

        The lookup is made using the current servers active context.

        Will return null if the groups display name is equal to it's actual name.

        Returns:
        the display name
      • getDisplayName

        @Nullable String getDisplayName​(@NonNull QueryOptions queryOptions)
        Gets the groups "display name", if it has one that differs from it's actual name.

        Will return null if the groups display name is equal to it's actual name.

        Parameters:
        queryOptions - the query options to lookup in
        Returns:
        the display name
      • getWeight

        @NonNull OptionalInt getWeight()
        Gets the weight of this group, if present.
        Returns:
        the group weight