[java-opensaml] branch master updated: Add deprecation warnings and more complete annotations.

Scott Cantor cantor.2 at osu.edu
Mon Dec 9 16:22:56 EST 2019


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

scantor pushed a commit to branch master
in repository java-opensaml.

View the commit online:
http://git.shibboleth.net/view/?p=java-opensaml.git;a=commit;h=1a106df2f442680bb2b043d0b2652a10abc390a4

The following commit(s) were added to refs/heads/master by this push:
       new  1a106df   Add deprecation warnings and more complete annotations.
1a106df is described below

commit 1a106df2f442680bb2b043d0b2652a10abc390a4
Author: Scott Cantor <cantor.2 at osu.edu>
AuthorDate: Mon Dec 9 15:22:13 2019 -0600

    Add deprecation warnings and more complete annotations.
---
 .../java/org/opensaml/saml/ext/saml2mdui/DomainHint.java  | 15 +++++++++------
 .../org/opensaml/saml/ext/saml2mdui/GeolocationHint.java  | 12 +++++++-----
 .../main/java/org/opensaml/saml/ext/saml2mdui/IPHint.java | 14 ++++++++------
 .../main/java/org/opensaml/saml/ext/saml2mdui/Logo.java   | 10 ++++++----
 4 files changed, 30 insertions(+), 21 deletions(-)

diff --git a/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdui/DomainHint.java b/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdui/DomainHint.java
index 8b0470d..bb49cbd 100644
--- a/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdui/DomainHint.java
+++ b/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdui/DomainHint.java
@@ -26,6 +26,8 @@ import org.opensaml.saml.common.SAMLObject;
 import org.opensaml.saml.common.xml.SAMLConstants;
 
 import net.shibboleth.utilities.java.support.annotation.constraint.NotEmpty;
+import net.shibboleth.utilities.java.support.primitive.DeprecationSupport;
+import net.shibboleth.utilities.java.support.primitive.DeprecationSupport.ObjectType;
 
 /**
  * DomainHint.
@@ -47,13 +49,13 @@ public interface DomainHint extends SAMLObject, XSString {
             new QName(SAMLConstants.SAML20MDUI_NS, DEFAULT_ELEMENT_LOCAL_NAME, SAMLConstants.SAML20MDUI_PREFIX);
     
     /**
-     * Gets the Hint.
+     * Gets the hint.
      * 
-     * @return the Hint
-     * 
-     * @deprecated
+     * @return the hint
      */
+    @Deprecated(forRemoval=true, since="4.0.0")
     @Nullable default String getHint() {
+        DeprecationSupport.warn(ObjectType.METHOD, "getHint", DomainHint.class.toString(), "getValue");
         return getValue();
     }
     
@@ -61,10 +63,11 @@ public interface DomainHint extends SAMLObject, XSString {
      * Sets the hint.
      * 
      * @param value hint
-     * 
-     * @deprecated
      */
+    @Deprecated(forRemoval=true, since="4.0.0")
     default void setHint(@Nullable final String value) {
+        DeprecationSupport.warn(ObjectType.METHOD, "setHint", DomainHint.class.toString(), "setValue");
         setValue(value);
     }
+
 }
\ No newline at end of file
diff --git a/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdui/GeolocationHint.java b/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdui/GeolocationHint.java
index 0e51059..13a3e79 100644
--- a/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdui/GeolocationHint.java
+++ b/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdui/GeolocationHint.java
@@ -26,6 +26,8 @@ import org.opensaml.saml.common.SAMLObject;
 import org.opensaml.saml.common.xml.SAMLConstants;
 
 import net.shibboleth.utilities.java.support.annotation.constraint.NotEmpty;
+import net.shibboleth.utilities.java.support.primitive.DeprecationSupport;
+import net.shibboleth.utilities.java.support.primitive.DeprecationSupport.ObjectType;
 
 /**
  * GeolocationHint.
@@ -48,13 +50,13 @@ public interface GeolocationHint extends SAMLObject, XSURI {
             new QName(SAMLConstants.SAML20MDUI_NS, DEFAULT_ELEMENT_LOCAL_NAME, SAMLConstants.SAML20MDUI_PREFIX);
     
     /**
-     * Gets the Hint.
+     * Gets the hint.
      * 
      * @return the Hint
-     * 
-     * @deprecated
      */
+    @Deprecated(forRemoval=true, since="4.0.0")
     @Nullable default String getHint() {
+        DeprecationSupport.warn(ObjectType.METHOD, "getHint", GeolocationHint.class.toString(), "getURI");
         return getURI();
     }
     
@@ -62,10 +64,10 @@ public interface GeolocationHint extends SAMLObject, XSURI {
      * Sets the hint.
      * 
      * @param value hint
-     * 
-     * @deprecated
      */
+    @Deprecated(forRemoval=true, since="4.0.0")
     default void setHint(@Nullable final String value) {
+        DeprecationSupport.warn(ObjectType.METHOD, "setHint", GeolocationHint.class.toString(), "setURI");
         setURI(value);
     }
 }
\ No newline at end of file
diff --git a/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdui/IPHint.java b/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdui/IPHint.java
index a8956ed..8c988c3 100644
--- a/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdui/IPHint.java
+++ b/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdui/IPHint.java
@@ -26,6 +26,8 @@ import org.opensaml.saml.common.SAMLObject;
 import org.opensaml.saml.common.xml.SAMLConstants;
 
 import net.shibboleth.utilities.java.support.annotation.constraint.NotEmpty;
+import net.shibboleth.utilities.java.support.primitive.DeprecationSupport;
+import net.shibboleth.utilities.java.support.primitive.DeprecationSupport.ObjectType;
 
 /**
  * IPHint.
@@ -47,13 +49,13 @@ public interface IPHint extends SAMLObject, XSString {
             new QName(SAMLConstants.SAML20MDUI_NS, DEFAULT_ELEMENT_LOCAL_NAME, SAMLConstants.SAML20MDUI_PREFIX);
     
     /**
-     * Gets the Hint.
+     * Gets the hint.
      * 
-     * @return the Hint
-     * 
-     * @deprecated
+     * @return the hint
      */
+    @Deprecated(forRemoval=true, since="4.0.0")
     @Nullable default String getHint() {
+        DeprecationSupport.warn(ObjectType.METHOD, "getHint", IPHint.class.toString(), "getValue");
         return getValue();
     }
     
@@ -61,10 +63,10 @@ public interface IPHint extends SAMLObject, XSString {
      * Sets the hint.
      * 
      * @param value hint
-     * 
-     * @deprecated
      */
+    @Deprecated(forRemoval=true, since="4.0.0")
     default void setHint(@Nullable final String value) {
+        DeprecationSupport.warn(ObjectType.METHOD, "setHint", IPHint.class.toString(), "setValue");
         setValue(value);
     }
 
diff --git a/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdui/Logo.java b/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdui/Logo.java
index 64260b4..4f2e4cb 100644
--- a/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdui/Logo.java
+++ b/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdui/Logo.java
@@ -26,6 +26,8 @@ import org.opensaml.saml.common.xml.SAMLConstants;
 import org.opensaml.saml.saml2.metadata.LocalizedURI;
 
 import net.shibboleth.utilities.java.support.annotation.constraint.NotEmpty;
+import net.shibboleth.utilities.java.support.primitive.DeprecationSupport;
+import net.shibboleth.utilities.java.support.primitive.DeprecationSupport.ObjectType;
 
 /**
  * Localized logo type.
@@ -62,10 +64,10 @@ public interface Logo extends LocalizedURI, SAMLObject {
      * Gets the URL.
      * 
      * @return the URL
-     * 
-     * @deprecated
      */
+    @Deprecated(forRemoval=true, since="4.0.0")
     @Nullable default String getURL() {
+        DeprecationSupport.warn(ObjectType.METHOD, "getURL", Logo.class.toString(), "getURI");
         return getURI();
     }
     
@@ -73,10 +75,10 @@ public interface Logo extends LocalizedURI, SAMLObject {
      * Sets the URL.
      * 
      * @param uri the URL
-     * 
-     * @deprecated
      */
+    @Deprecated(forRemoval=true, since="4.0.0")
     default void setURL(@Nullable final String uri) {
+        DeprecationSupport.warn(ObjectType.METHOD, "setURL", Logo.class.toString(), "setURI");
         setURI(uri);
     }
 

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


More information about the commits mailing list