Skip to Content.
Sympa Menu

grouper-dev - [grouper-dev] Doc bug... misc/GrouperCheckConfig.java

Subject: Grouper Developers Forum

List archive

[grouper-dev] Doc bug... misc/GrouperCheckConfig.java


Chronological Thread 
  • From: "Black, Carey M." <>
  • To: "" <>
  • Subject: [grouper-dev] Doc bug... misc/GrouperCheckConfig.java
  • Date: Tue, 14 Aug 2018 06:57:59 +0000
  • Accept-language: en-US
  • Authentication-results: spf=pass (sender IP is 128.146.163.17) smtp.mailfrom=osu.edu; internet2.edu; dkim=pass (signature was verified) header.d=osu.edu;internet2.edu; dmarc=pass action=none header.from=osu.edu;
  • Authentication-results-original: spf=none (sender IP is ) ;
  • Ironport-phdr: 9a23:1Jag1xYMtrWGbBbO4vpS6bX/LSx+4OfEezUN459isYplN5qZrs29bnLW6fgltlLVR4KTs6sC17KI9fi4EUU7or+5+EgYd5JNUxJXwe43pCcHRPC/NEvgMfTxZDY7FskRHHVs/nW8LFQHUJ2mPw6arXK99yMdFQviPgRpOOv1BpTSj8Oq3Oyu5pHfeQpFiCa8bL9oMBm6sRjau9ULj4dlNqs/0AbCrGFSe+RRy2NoJFaTkAj568yt4pNt8Dletuw4+cJYXqr0Y6o3TbpDDDQ7KG81/9HktQPCTQSU+HQRVHgdnwdSDAjE6BH6WYrxsjf/u+Fg1iSWIdH6QLYpUjmk8qxlSgLniD0fOjA57m/Zl9BwgqxYrhKguxNxzIHbbZqJNPpnYq/RYc8WSXZfUstXSidPApm8b4wKD+cZM+pVso39qEESohu9HQWnGf3ixSVShnDo3awxzuMvHRvI0Ac9GN8Bq3DUo8/pO6cRS+y50bfEwDvYYvNRwjf99ZLEfQ48rvGRRL99d9fax0o3Fw7dkFmfs5DpMy6Q2+gQrmSX8u9tVeyghmI7tw18pzavydkjh4TIg48Yz1LJ+Thjz4otO9G1R1R3bcC4HJZTrS2WKZV6T804T211uis3yaUKuZClcyUJ1JgqwhvSZOKIfoeU+B3uUemcLit3iX14fb+yhgu98Uagx+D5TMa501ZHojZDn9LRrH4CzQbT5dKCSvZl/keuxzKP1wfL5+9cPU06krbXJ4A4zrMtkJQfr13PHijtl0rolqOWcVgk+vSz5OTgf7XmoIKTO5VsigHkNaQuhtKwDvgkMggPWGib//6w1Lr+/U3lRLVKifo2kqrDvJ/GIsQbo7a1Aw5T0ok99xayFymq384EkXUaKV9JZQ+Lg5XsNlHAL/30EeuzjlGikDh1yP3LP7jsD5DPI3TeirjtZbN95FRdyAo3w9Bf/ZVUCrQZLf3oXk/+rsDXDhwjPwCp3erqBs5w1oQFWWKSGKOWLr7dsUKQ6uI1P+aMfJMVuCr6K/U96P7ul3g5mUIFfaa3x5sbcW23Eep4I0iCZXrsg8wBEXsRvgYgVuDqiVuCUSJNaHaoWaIz+C07BJy8AYjdW4+tne/J4CDuVJJMYX1eB0rJHXr2X4SCR/oWbi+OeIlsniFOHeyuUYg8zRy08QP31ZJmKPbZ4CsVqcil2dRosb79jxY3oHZeC82W0CXFZGhuk3JAYnl8lPR1pUV2yRHai/NQhOdFU9Ff+qUaAU8BKZfAwrkiWJjJUQXbc4LREgz0S8i6ATw3UtM6ysMPZEA4Adi5kxTfxHP7Wu0Oj7LeHJUv6eqcxHX3K8tng1f+nKg6xwB8Eo0WaTPg3/AksVGMRuur216ci77scK0d2CDX82LWynGT+kxUTV04UKPZUGoZa1eM69n1+xCKQ7yvDOE/OxBagY6ZK6RMY8H0l1gOW/74cMrTeWO/mmq8RHPqjrOBZYbnYSMRiSLGFQ4Jnx1A/HCaOBI4Czv75W/SEW8mGVfmeUi56eBlszuyRVM1yAffaUpn2vK19xcZiObaRekU2+cDozpnpjlpT1s=
  • Spamdiagnosticmetadata: NSPM
  • Spamdiagnosticoutput: 1:99

I know this is "picky" ( and has been broken for a while ), it is also almost
3 AM and it took me over an hour to find this bug...... ( I now have less
hair than I started with. )

Please correct the Javadoc.


/grouper/src/grouper/edu/internet2/middleware/grouper/misc/GrouperCheckConfig.java
......

/**
* make sure an attribute is there or add it if not
* @param stem
* @param attributeDef
* @param extension
* @param description
* @param logAutocreate
* @return the attribute def name
*/
private static AttributeDefName checkAttribute(Stem stem, AttributeDef
attributeDef, String extension, String description, boolean logAutocreate) {
return checkAttribute(stem, attributeDef, extension, extension,
description, logAutocreate);
}


THEN... you injected "displayExtension" BEFORE "description" on the
signature of the next Method. (WT???? append to the end.... always
append.....)
AND the order of the @param values in the method Javadoc is not the same
order as the method. ( Since they are just "strings" it is very easy to NOT
get what you want from the method. )

/**
* make sure an attribute is there or add it if not
* @param stem
* @param attributeDef
* @param extension
* @param description
* @param displayExtension
* @param logAutocreate
* @return the attribute def name
*/
private static AttributeDefName checkAttribute(Stem stem, AttributeDef
attributeDef, String extension, String displayExtension, String description,
boolean logAutocreate) {
....


--
Carey Matthew






Archive powered by MHonArc 2.6.19.

Top of Page