[java-support] 04/04: Javadoc fixes

Ian Young ian at iay.org.uk
Mon Oct 2 10:42:16 EDT 2017


This is an automated email from the git hooks/post-receive script.

iay pushed a commit to branch master
in repository java-support.

View the commit online:
http://git.shibboleth.net/view/?p=java-support.git;a=commit;h=4b41dac2a96fad6ce7164b567b1426926e26224d

commit 4b41dac2a96fad6ce7164b567b1426926e26224d
Author: Ian Young <ian at iay.org.uk>
AuthorDate: Mon Oct 2 15:04:25 2017 +0100

    Javadoc fixes
---
 .../utilities/java/support/httpclient/TLSSocketFactory.java         | 6 +++---
 .../utilities/java/support/httpclient/TLSSocketFactoryBuilder.java  | 4 ++--
 .../net/shibboleth/utilities/java/support/resource/Resource.java    | 2 --
 3 files changed, 5 insertions(+), 7 deletions(-)

diff --git a/src/main/java/net/shibboleth/utilities/java/support/httpclient/TLSSocketFactory.java b/src/main/java/net/shibboleth/utilities/java/support/httpclient/TLSSocketFactory.java
index 64d0360..2b74cdf 100644
--- a/src/main/java/net/shibboleth/utilities/java/support/httpclient/TLSSocketFactory.java
+++ b/src/main/java/net/shibboleth/utilities/java/support/httpclient/TLSSocketFactory.java
@@ -67,11 +67,11 @@ import org.slf4j.LoggerFactory;
 public class TLSSocketFactory implements LayeredConnectionSocketFactory {
     
     /** HttpContext key for a a list of TLS protocols to enable on the socket.  
-     * Must be an instance of {@link List<String>}. */
+     * Must be an instance of {@link List}<{@link String}>. */
     public static final String CONTEXT_KEY_TLS_PROTOCOLS = "javasupport.TLSProtocols";
     
     /** HttpContext key for a a list of TLS cipher suites to enable on the socket.  
-     * Must be an instance of {@link List<String>}. */
+     * Must be an instance of {@link List}<{@link String}>. */
     public static final String CONTEXT_KEY_TLS_CIPHER_SUITES = "javasupport.TLSCipherSuites";
     
     /** HttpContext key for an instance of {@link X509HostnameVerifier}. */
@@ -359,7 +359,7 @@ public class TLSSocketFactory implements LayeredConnectionSocketFactory {
     }
 
     /**
-     * Get a normalized String array from a context attribute holding a {@link List<String>}.
+     * Get a normalized String array from a context attribute holding a {@link List}<{@link String}>.
      * 
      * @param context the current HttpContext
      * @param contextKey the attribute context key
diff --git a/src/main/java/net/shibboleth/utilities/java/support/httpclient/TLSSocketFactoryBuilder.java b/src/main/java/net/shibboleth/utilities/java/support/httpclient/TLSSocketFactoryBuilder.java
index bfef4a9..f7ebd17 100644
--- a/src/main/java/net/shibboleth/utilities/java/support/httpclient/TLSSocketFactoryBuilder.java
+++ b/src/main/java/net/shibboleth/utilities/java/support/httpclient/TLSSocketFactoryBuilder.java
@@ -103,7 +103,7 @@ public class TLSSocketFactoryBuilder {
 
     /**
      * Get the JCA provider name used when obtaining an instance of {@link SSLContext}
-     * via {@link SSLContext#getInstance(String, String))}.
+     * via {@link SSLContext#getInstance(String, String)}.
      * 
      * @return the provider namer, or null
      */
@@ -300,7 +300,7 @@ public class TLSSocketFactoryBuilder {
     }
     
     /**
-     * Build a new instance of {@SSLContext} based on the properties specified on this builder instance.
+     * Build a new instance of {@link SSLContext} based on the properties specified on this builder instance.
      * 
      * @return a new SSLContext instance
      */
diff --git a/src/main/java/net/shibboleth/utilities/java/support/resource/Resource.java b/src/main/java/net/shibboleth/utilities/java/support/resource/Resource.java
index 9bf3131..388fd28 100644
--- a/src/main/java/net/shibboleth/utilities/java/support/resource/Resource.java
+++ b/src/main/java/net/shibboleth/utilities/java/support/resource/Resource.java
@@ -104,8 +104,6 @@ public interface Resource {
      * 
      * @return the input stream for the underlying resource (must not be {@code null})
      * @throws IOException if the stream could not be opened
-     * @see org.springframework.mail.javamail.MimeMessageHelper#addAttachment(String,
-     *      org.springframework.core.io.InputStreamSource)
      */
     @Nonnull InputStream getInputStream() throws IOException;
 

-- 
To stop receiving notification emails like this one, please contact
the administrator of this repository.


More information about the commits mailing list