Use consistent "@" tag order in Javadoc

Ensure that Javadoc "@" tags appear in a consistent and well defined order. Issue gh-8945
2026-08-05 17:57:15 +00:00 · 2020-07-24 15:03:32 -07:00
parent 7f0653fa34
commit 5f64f53c3f
195 changed files with 556 additions and 607 deletions
@@ -34,9 +34,9 @@ import static org.springframework.util.Assert.state;
 * "https://www.oasis-open.org/committees/download.php/8958/sstc-saml-implementation-guidelines-draft-01.pdf">
 * usages </a> (Line 584, Section 4.3 Credentials).
 *
- * @since 5.4
 * @author Filip Hanik
 * @author Josh Cummings
+ * @since 5.4
 */
 public final class Saml2X509Credential {

@@ -140,7 +140,7 @@ public final class Saml2X509Credential {
 	/**
 	 * Get the private key for this credential
 	 * @return the private key, may be null
-	 * @see {@link #Saml2X509Credential(PrivateKey, X509Certificate, Saml2X509CredentialType...)}
+	 * @see #Saml2X509Credential(PrivateKey, X509Certificate, Saml2X509CredentialType...)
 	 */
 	public PrivateKey getPrivateKey() {
 		return this.privateKey;
@@ -157,7 +157,7 @@ public class Saml2X509Credential {
 	/**
 	 * Returns the private key, or null if this credential type doesn't require one.
 	 * @return the private key, or null
-	 * @see {@link #Saml2X509Credential(PrivateKey, X509Certificate, Saml2X509CredentialType...)}
+	 * @see #Saml2X509Credential(PrivateKey, X509Certificate, Saml2X509CredentialType...)
 	 */
 	public PrivateKey getPrivateKey() {
 		return this.privateKey;
@@ -30,9 +30,9 @@ import java.nio.charset.Charset;
 * https://www.oasis-open.org/committees/download.php/35711/sstc-saml-core-errata-2.0-wd-06-diff.pdf
 * (line 2031)
 *
+ * @since 5.3
 * @see Saml2AuthenticationRequestFactory#createPostAuthenticationRequest(Saml2AuthenticationRequestContext)
 * @see Saml2AuthenticationRequestFactory#createRedirectAuthenticationRequest(Saml2AuthenticationRequestContext)
- * @since 5.3
 */
 abstract class AbstractSaml2AuthenticationRequest {

@@ -185,7 +185,7 @@ public final class Saml2AuthenticationRequest {
 		/**
 		 * Creates a {@link Saml2AuthenticationRequest} object.
 		 * @return the Saml2AuthenticationRequest object
-		 * @throws {@link IllegalArgumentException} if a required property is not set
+		 * @throws IllegalArgumentException if a required property is not set
 		 */
 		public Saml2AuthenticationRequest build() {
 			return new Saml2AuthenticationRequest(this.issuer, this.destination, this.assertionConsumerServiceUrl,
@@ -25,9 +25,9 @@ import org.springframework.util.Assert;
 * "https://www.oasis-open.org/committees/download.php/35711/sstc-saml-core-errata-2.0-wd-06-diff.pdf">
 * Assertions and Protocols for SAML 2 (line 2031)</a>
 *
+ * @since 5.3
 * @see Saml2AuthenticationRequestFactory#createPostAuthenticationRequest(Saml2AuthenticationRequestContext)
 * @see Saml2AuthenticationRequestFactory#createRedirectAuthenticationRequest(Saml2AuthenticationRequestContext)
- * @since 5.3
 */
 public class Saml2AuthenticationRequestContext {

@@ -167,7 +167,7 @@ public class Saml2AuthenticationRequestContext {
 		/**
 		 * Creates a {@link Saml2AuthenticationRequestContext} object.
 		 * @return the Saml2AuthenticationRequest object
-		 * @throws {@link IllegalArgumentException} if a required property is not set
+		 * @throws IllegalArgumentException if a required property is not set
 		 */
 		public Saml2AuthenticationRequestContext build() {
 			return new Saml2AuthenticationRequestContext(this.relyingPartyRegistration, this.issuer,
@@ -30,9 +30,9 @@ import static org.springframework.security.saml2.provider.service.registration.R
 * Represents an incoming SAML 2.0 response containing an assertion that has not been
 * validated. {@link Saml2AuthenticationToken#isAuthenticated()} will always return false.
 *
- * @since 5.2
 * @author Filip Hanik
 * @author Josh Cummings
+ * @since 5.2
 */
 public class Saml2AuthenticationToken extends AbstractAuthenticationToken {

@@ -71,7 +71,7 @@ public class Saml2AuthenticationToken extends AbstractAuthenticationToken {
 	 * @param localSpEntityId the configured local SP, the relying party, entity ID
 	 * @param credentials the credentials configured for signature verification and
 	 * decryption
-	 * @deprecated Use {@link Saml2AuthenticationToken(RelyingPartyRegistration, String)}
+	 * @deprecated Use {@link #Saml2AuthenticationToken(RelyingPartyRegistration, String)}
 	 * instead
 	 */
 	@Deprecated
@@ -125,8 +125,7 @@ public class Saml2AuthenticationToken extends AbstractAuthenticationToken {
 	 * Returns the URI that the SAML 2 Response object came in on
 	 * @return URI as a string
 	 * @deprecated Use
-	 * {@link #getRelyingPartyRegistration().getAssertionConsumerServiceLocation()}
-	 * instead
+	 * {@code getRelyingPartyRegistration().getAssertionConsumerServiceLocation()} instead
 	 */
 	@Deprecated
 	public String getRecipientUri() {
@@ -136,7 +135,7 @@ public class Saml2AuthenticationToken extends AbstractAuthenticationToken {
 	/**
 	 * Returns the configured entity ID of the receiving relying party, SP
 	 * @return an entityID for the configured local relying party
-	 * @deprecated Use {@link #getRelyingPartyRegistration().getEntityId()} instead
+	 * @deprecated Use {@code getRelyingPartyRegistration().getEntityId()} instead
 	 */
 	@Deprecated
 	public String getLocalSpEntityId() {
@@ -145,7 +144,7 @@ public class Saml2AuthenticationToken extends AbstractAuthenticationToken {

 	/**
 	 * Returns all the credentials associated with the relying party configuraiton
-	 * @return
+	 * @return all associated credentials
 	 * @deprecated Get the credentials through {@link #getRelyingPartyRegistration()}
 	 * instead
 	 */
@@ -165,7 +164,6 @@ public class Saml2AuthenticationToken extends AbstractAuthenticationToken {
 	/**
 	 * The state of this object cannot be changed. Will always throw an exception
 	 * @param authenticated ignored
-	 * @throws {@link IllegalArgumentException}
 	 */
 	@Override
 	public void setAuthenticated(boolean authenticated) {
@@ -176,7 +174,7 @@ public class Saml2AuthenticationToken extends AbstractAuthenticationToken {
 	 * Returns the configured IDP, asserting party, entity ID
 	 * @return a string representing the entity ID
 	 * @deprecated Use
-	 * {@link #getRelyingPartyRegistration().getAssertingPartyDetails().getEntityId()}
+	 * {@code getRelyingPartyRegistration().getAssertingPartyDetails().getEntityId()}
 	 * instead
 	 */
 	@Deprecated
@@ -26,8 +26,8 @@ import static org.springframework.security.saml2.provider.service.registration.S
 * https://www.oasis-open.org/committees/download.php/35711/sstc-saml-core-errata-2.0-wd-06-diff.pdf
 * (line 2031)
 *
- * @see Saml2AuthenticationRequestFactory
 * @since 5.3
+ * @see Saml2AuthenticationRequestFactory
 */
 public class Saml2PostAuthenticationRequest extends AbstractSaml2AuthenticationRequest {

@@ -26,8 +26,8 @@ import static org.springframework.security.saml2.provider.service.registration.S
 * https://www.oasis-open.org/committees/download.php/35711/sstc-saml-core-errata-2.0-wd-06-diff.pdf
 * (line 2031)
 *
- * @see Saml2AuthenticationRequestFactory
 * @since 5.3
+ * @see Saml2AuthenticationRequestFactory
 */
 public class Saml2RedirectAuthenticationRequest extends AbstractSaml2AuthenticationRequest {

@@ -67,9 +67,9 @@ import org.springframework.util.Assert;
 * 			.build();
 * </pre>
 *
- * @since 5.2
 * @author Filip Hanik
 * @author Josh Cummings
+ * @since 5.2
 */
 public class RelyingPartyRegistration {

@@ -284,7 +284,7 @@ public class RelyingPartyRegistration {
 	 * @return a filtered list containing only credentials of type
 	 * {@link org.springframework.security.saml2.credentials.Saml2X509Credential.Saml2X509CredentialType#VERIFICATION}.
 	 * Returns an empty list of credentials are not found
-	 * @deprecated Use {@link #getAssertingPartyDetails().getSigningX509Credentials()}
+	 * @deprecated Use {code #getAssertingPartyDetails().getSigningX509Credentials()}
 	 * instead
 	 */
 	@Deprecated
@@ -909,8 +909,8 @@ public class RelyingPartyRegistration {
 		 * Provider.
 		 * @param entityId the IDP entityId
 		 * @return this object
-		 * @deprecated use {@link #assertingPartyDetails(Consumer<
-		 * AssertingPartyDetails.Builder >)}
+		 * @deprecated use
+		 * {@code #assertingPartyDetails(Consumer<AssertingPartyDetails.Builder >)}
 		 */
 		@Deprecated
 		public Builder remoteIdpEntityId(String entityId) {
@@ -923,8 +923,8 @@ public class RelyingPartyRegistration {
 		 * @param url - a URL that accepts authentication requests via REDIRECT or POST
 		 * bindings
 		 * @return this object
-		 * @deprecated use {@link #assertingPartyDetails(Consumer<
-		 * AssertingPartyDetails.Builder >)}
+		 * @deprecated use
+		 * {@code #assertingPartyDetails(Consumer<AssertingPartyDetails.Builder >)}
 		 */
 		@Deprecated
 		public Builder idpWebSsoUrl(String url) {
@@ -19,8 +19,8 @@ package org.springframework.security.saml2.provider.service.registration;
 /**
 * A repository for {@link RelyingPartyRegistration}s
 *
- * @since 5.2
 * @author Filip Hanik
+ * @since 5.2
 */
 public interface RelyingPartyRegistrationRepository {

@@ -64,9 +64,9 @@ import static java.nio.charset.StandardCharsets.ISO_8859_1;
 * {@link RelyingPartyRegistration#getRegistrationId() registration identifier} of the
 * relying party that is used for initiating the authentication request.
 *
- * @since 5.2
 * @author Filip Hanik
 * @author Josh Cummings
+ * @since 5.2
 */
 public class Saml2WebSsoAuthenticationRequestFilter extends OncePerRequestFilter {

@@ -40,8 +40,8 @@ import static org.springframework.web.util.UriComponentsBuilder.fromHttpUrl;
 * registration id from the request, querying a
 * {@link RelyingPartyRegistrationRepository}, and resolving any template values.
 *
- * @since 5.4
 * @author Josh Cummings
+ * @since 5.4
 */
 public final class DefaultRelyingPartyRegistrationResolver
 		implements Converter<HttpServletRequest, RelyingPartyRegistration> {