@PublicApi public interface


Known Indirect Subclasses


This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

Service that retrieves a collection of Group objects based on a partial query string


Public Methods
List<Group> findGroups(String query)
Get groups based on a query string.
Group getGroupByName(String groupName)
Returns a group by name.

Public Methods

public List<Group> findGroups (String query)

Get groups based on a query string. Will be unique and sorted. Results are sorted according to the com.atlassian.crowd.embedded.api.GroupComparator.

query String to search for.
  • List of Group objects that match criteria.

public Group getGroupByName (String groupName)

Returns a group by name.

groupName The group name
  • The group (if any)