[JENKINS-36494] Clarify that the previousContext is never null per JavaDoc for SecurityContextHolder.getContext()

This commit is contained in:
Stephen Connolly committed 2016-07-08 15:53:00 +01:00
1 parent 0203504a2c
commit 85f64d4e06
1 file changed
+5 -3
@@ -24,6 +24,7 @@
package hudson.security;
import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;
import org.acegisecurity.Authentication;
import org.acegisecurity.context.SecurityContext;
import org.acegisecurity.context.SecurityContextHolder;
@@ -38,13 +39,14 @@ public class ACLContext implements AutoCloseable {
/**
* The previous context.
*/
@Nonnull
private final SecurityContext previousContext;
/**
* Private constructor to ensure only instance creation is from {@link ACL#as(Authentication)}.
* @param previousContext
* @param previousContext the previous context
*/
ACLContext(SecurityContext previousContext) {
ACLContext(@Nonnull SecurityContext previousContext) {
this.previousContext = previousContext;
}
@@ -52,7 +54,7 @@ public class ACLContext implements AutoCloseable {
* Accessor for the previous context.
* @return the previous context.
*/
@CheckForNull
@Nonnull
public SecurityContext getPreviousContext() {
return previousContext;
}