diff --git a/core/src/main/java/org/springframework/security/access/hierarchicalroles/RoleHierarchy.java b/core/src/main/java/org/springframework/security/access/hierarchicalroles/RoleHierarchy.java index 332f6c067f..62abd13921 100755 --- a/core/src/main/java/org/springframework/security/access/hierarchicalroles/RoleHierarchy.java +++ b/core/src/main/java/org/springframework/security/access/hierarchicalroles/RoleHierarchy.java @@ -22,22 +22,23 @@ import org.springframework.security.core.GrantedAuthority; * The simple interface of a role hierarchy. * * @author Michael Mayr - * */ public interface RoleHierarchy { /** - * This method returns an array of all reachable authorities.
+ * Returns an array of all reachable authorities. + *

* Reachable authorities are the directly assigned authorities plus all * authorities that are (transitively) reachable from them in the role - * hierarchy.
+ * hierarchy. + *

* Example:
* Role hierarchy: ROLE_A > ROLE_B and ROLE_B > ROLE_C.
* Directly assigned authority: ROLE_A.
* Reachable authorities: ROLE_A, ROLE_B, ROLE_C. * - * @param authorities - Array of the directly assigned authorities. - * @return Array of all reachable authorities given the assigned authorities. + * @param authorities - List of the directly assigned authorities. + * @return List of all reachable authorities given the assigned authorities. */ public List getReachableGrantedAuthorities(List authorities);