You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by Thomas Neidhart <th...@gmail.com> on 2014/10/19 14:26:43 UTC
Re: svn commit: r1632886 - in /commons/proper/collections/trunk/src:
changes/changes.xml main/java/org/apache/commons/collections4/keyvalue/MultiKey.java
On 10/19/2014 12:10 PM, britter@apache.org wrote:
> Author: britter
> Date: Sun Oct 19 10:10:45 2014
> New Revision: 1632886
>
> URL: http://svn.apache.org/r1632886
> Log:
> COLLECTIONS-535: Clarify JavaDoc of MultiKey getKey() and size(). This closes #4 from github. Thanks to Alexander Kjäll
>
> Modified:
> commons/proper/collections/trunk/src/changes/changes.xml
> commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/keyvalue/MultiKey.java
>
> Modified: commons/proper/collections/trunk/src/changes/changes.xml
> URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/changes/changes.xml?rev=1632886&r1=1632885&r2=1632886&view=diff
> ==============================================================================
> --- commons/proper/collections/trunk/src/changes/changes.xml (original)
> +++ commons/proper/collections/trunk/src/changes/changes.xml Sun Oct 19 10:10:45 2014
> @@ -22,6 +22,9 @@
> <body>
>
> <release version="4.1" date="TBD" description="">
> + <action issue="COLLECTIONS-535" dev="britter" type="update" due-to="Alexander Kjäll">
> + Clarify JavaDoc of MultiKey getKey() and size()
> + </action>
> <action issue="COLLECTIONS-529" dev="tn" type="add" due-to="Alexander Muthmann, Dipanjan Laha">
> Added methods "removeAll(...)" and "retainAll(...)" to "CollectionUtils" that perform
> equality checks using the provided "Equator" object instead of "Object#equals()".
>
> Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/keyvalue/MultiKey.java
> URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/keyvalue/MultiKey.java?rev=1632886&r1=1632885&r2=1632886&view=diff
> ==============================================================================
> --- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/keyvalue/MultiKey.java (original)
> +++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/keyvalue/MultiKey.java Sun Oct 19 10:10:45 2014
> @@ -182,7 +182,8 @@ public class MultiKey<K> implements Seri
> }
>
> /**
> - * Gets the key at the specified index.
> + * Gets the key at the specified index.
> + * The index enumeration starts at 0.
This is the default in the java language and does not need explicit
mentioning imho.
> * <p>
> * The key should be immutable.
> * If it is not then it must not be changed.
> @@ -197,7 +198,7 @@ public class MultiKey<K> implements Seri
> }
>
> /**
> - * Gets the size of the list of keys.
> + * Gets the size of the list of keys, this number is the number of values this object was created with.
this comment just adds more confusion, and I fail to see how the
original comment needs more clarification as the description is pretty
clear to me.
> *
> * @return the size of the list of keys
> * @since 3.1
>
>
Thomas
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org
Re: svn commit: r1632886 - in /commons/proper/collections/trunk/src:
changes/changes.xml main/java/org/apache/commons/collections4/keyvalue/MultiKey.java
Posted by Benedikt Ritter <br...@apache.org>.
Done!
2014-10-20 17:38 GMT+02:00 Thomas Neidhart <th...@gmail.com>:
> Thanks,
>
> I would close the ticket as "Not a problem", unless the OP can explain what
> it not clear from the existing javadoc.
>
> Thomas
>
> On Mon, Oct 20, 2014 at 4:42 PM, Benedikt Ritter <br...@apache.org>
> wrote:
>
> > Hello Thomas,
> >
> > sorry, was a bit premature to apply this patch. After giving this more
> > thought, I agree with you. I have reverted the changes.
> >
> > Thanks for catching that!
> >
> > Benedikt
> >
> > 2014-10-19 14:26 GMT+02:00 Thomas Neidhart <th...@gmail.com>:
> >
> > > On 10/19/2014 12:10 PM, britter@apache.org wrote:
> > > > Author: britter
> > > > Date: Sun Oct 19 10:10:45 2014
> > > > New Revision: 1632886
> > > >
> > > > URL: http://svn.apache.org/r1632886
> > > > Log:
> > > > COLLECTIONS-535: Clarify JavaDoc of MultiKey getKey() and size().
> This
> > > closes #4 from github. Thanks to Alexander Kjäll
> > > >
> > > > Modified:
> > > > commons/proper/collections/trunk/src/changes/changes.xml
> > > >
> > >
> >
> commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/keyvalue/MultiKey.java
> > > >
> > > > Modified: commons/proper/collections/trunk/src/changes/changes.xml
> > > > URL:
> > >
> >
> http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/changes/changes.xml?rev=1632886&r1=1632885&r2=1632886&view=diff
> > > >
> > >
> >
> ==============================================================================
> > > > --- commons/proper/collections/trunk/src/changes/changes.xml
> (original)
> > > > +++ commons/proper/collections/trunk/src/changes/changes.xml Sun Oct
> 19
> > > 10:10:45 2014
> > > > @@ -22,6 +22,9 @@
> > > > <body>
> > > >
> > > > <release version="4.1" date="TBD" description="">
> > > > + <action issue="COLLECTIONS-535" dev="britter" type="update"
> > > due-to="Alexander Kjäll">
> > > > + Clarify JavaDoc of MultiKey getKey() and size()
> > > > + </action>
> > > > <action issue="COLLECTIONS-529" dev="tn" type="add"
> > > due-to="Alexander Muthmann, Dipanjan Laha">
> > > > Added methods "removeAll(...)" and "retainAll(...)" to
> > > "CollectionUtils" that perform
> > > > equality checks using the provided "Equator" object instead of
> > > "Object#equals()".
> > > >
> > > > Modified:
> > >
> >
> commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/keyvalue/MultiKey.java
> > > > URL:
> > >
> >
> http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/keyvalue/MultiKey.java?rev=1632886&r1=1632885&r2=1632886&view=diff
> > > >
> > >
> >
> ==============================================================================
> > > > ---
> > >
> >
> commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/keyvalue/MultiKey.java
> > > (original)
> > > > +++
> > >
> >
> commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/keyvalue/MultiKey.java
> > > Sun Oct 19 10:10:45 2014
> > > > @@ -182,7 +182,8 @@ public class MultiKey<K> implements Seri
> > > > }
> > > >
> > > > /**
> > > > - * Gets the key at the specified index.
> > > > + * Gets the key at the specified index.
> > > > + * The index enumeration starts at 0.
> > >
> > > This is the default in the java language and does not need explicit
> > > mentioning imho.
> > >
> > > > * <p>
> > > > * The key should be immutable.
> > > > * If it is not then it must not be changed.
> > > > @@ -197,7 +198,7 @@ public class MultiKey<K> implements Seri
> > > > }
> > > >
> > > > /**
> > > > - * Gets the size of the list of keys.
> > > > + * Gets the size of the list of keys, this number is the number
> of
> > > values this object was created with.
> > >
> > > this comment just adds more confusion, and I fail to see how the
> > > original comment needs more clarification as the description is pretty
> > > clear to me.
> > >
> > > > *
> > > > * @return the size of the list of keys
> > > > * @since 3.1
> > > >
> > > >
> > >
> > > Thomas
> > >
> > > ---------------------------------------------------------------------
> > > To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> > > For additional commands, e-mail: dev-help@commons.apache.org
> > >
> > >
> >
> >
> > --
> > http://people.apache.org/~britter/
> > http://www.systemoutprintln.de/
> > http://twitter.com/BenediktRitter
> > http://github.com/britter
> >
>
--
http://people.apache.org/~britter/
http://www.systemoutprintln.de/
http://twitter.com/BenediktRitter
http://github.com/britter
Re: svn commit: r1632886 - in /commons/proper/collections/trunk/src:
changes/changes.xml main/java/org/apache/commons/collections4/keyvalue/MultiKey.java
Posted by Thomas Neidhart <th...@gmail.com>.
Thanks,
I would close the ticket as "Not a problem", unless the OP can explain what
it not clear from the existing javadoc.
Thomas
On Mon, Oct 20, 2014 at 4:42 PM, Benedikt Ritter <br...@apache.org> wrote:
> Hello Thomas,
>
> sorry, was a bit premature to apply this patch. After giving this more
> thought, I agree with you. I have reverted the changes.
>
> Thanks for catching that!
>
> Benedikt
>
> 2014-10-19 14:26 GMT+02:00 Thomas Neidhart <th...@gmail.com>:
>
> > On 10/19/2014 12:10 PM, britter@apache.org wrote:
> > > Author: britter
> > > Date: Sun Oct 19 10:10:45 2014
> > > New Revision: 1632886
> > >
> > > URL: http://svn.apache.org/r1632886
> > > Log:
> > > COLLECTIONS-535: Clarify JavaDoc of MultiKey getKey() and size(). This
> > closes #4 from github. Thanks to Alexander Kjäll
> > >
> > > Modified:
> > > commons/proper/collections/trunk/src/changes/changes.xml
> > >
> >
> commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/keyvalue/MultiKey.java
> > >
> > > Modified: commons/proper/collections/trunk/src/changes/changes.xml
> > > URL:
> >
> http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/changes/changes.xml?rev=1632886&r1=1632885&r2=1632886&view=diff
> > >
> >
> ==============================================================================
> > > --- commons/proper/collections/trunk/src/changes/changes.xml (original)
> > > +++ commons/proper/collections/trunk/src/changes/changes.xml Sun Oct 19
> > 10:10:45 2014
> > > @@ -22,6 +22,9 @@
> > > <body>
> > >
> > > <release version="4.1" date="TBD" description="">
> > > + <action issue="COLLECTIONS-535" dev="britter" type="update"
> > due-to="Alexander Kjäll">
> > > + Clarify JavaDoc of MultiKey getKey() and size()
> > > + </action>
> > > <action issue="COLLECTIONS-529" dev="tn" type="add"
> > due-to="Alexander Muthmann, Dipanjan Laha">
> > > Added methods "removeAll(...)" and "retainAll(...)" to
> > "CollectionUtils" that perform
> > > equality checks using the provided "Equator" object instead of
> > "Object#equals()".
> > >
> > > Modified:
> >
> commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/keyvalue/MultiKey.java
> > > URL:
> >
> http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/keyvalue/MultiKey.java?rev=1632886&r1=1632885&r2=1632886&view=diff
> > >
> >
> ==============================================================================
> > > ---
> >
> commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/keyvalue/MultiKey.java
> > (original)
> > > +++
> >
> commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/keyvalue/MultiKey.java
> > Sun Oct 19 10:10:45 2014
> > > @@ -182,7 +182,8 @@ public class MultiKey<K> implements Seri
> > > }
> > >
> > > /**
> > > - * Gets the key at the specified index.
> > > + * Gets the key at the specified index.
> > > + * The index enumeration starts at 0.
> >
> > This is the default in the java language and does not need explicit
> > mentioning imho.
> >
> > > * <p>
> > > * The key should be immutable.
> > > * If it is not then it must not be changed.
> > > @@ -197,7 +198,7 @@ public class MultiKey<K> implements Seri
> > > }
> > >
> > > /**
> > > - * Gets the size of the list of keys.
> > > + * Gets the size of the list of keys, this number is the number of
> > values this object was created with.
> >
> > this comment just adds more confusion, and I fail to see how the
> > original comment needs more clarification as the description is pretty
> > clear to me.
> >
> > > *
> > > * @return the size of the list of keys
> > > * @since 3.1
> > >
> > >
> >
> > Thomas
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> > For additional commands, e-mail: dev-help@commons.apache.org
> >
> >
>
>
> --
> http://people.apache.org/~britter/
> http://www.systemoutprintln.de/
> http://twitter.com/BenediktRitter
> http://github.com/britter
>
Re: svn commit: r1632886 - in /commons/proper/collections/trunk/src:
changes/changes.xml main/java/org/apache/commons/collections4/keyvalue/MultiKey.java
Posted by Benedikt Ritter <br...@apache.org>.
Hello Thomas,
sorry, was a bit premature to apply this patch. After giving this more
thought, I agree with you. I have reverted the changes.
Thanks for catching that!
Benedikt
2014-10-19 14:26 GMT+02:00 Thomas Neidhart <th...@gmail.com>:
> On 10/19/2014 12:10 PM, britter@apache.org wrote:
> > Author: britter
> > Date: Sun Oct 19 10:10:45 2014
> > New Revision: 1632886
> >
> > URL: http://svn.apache.org/r1632886
> > Log:
> > COLLECTIONS-535: Clarify JavaDoc of MultiKey getKey() and size(). This
> closes #4 from github. Thanks to Alexander Kjäll
> >
> > Modified:
> > commons/proper/collections/trunk/src/changes/changes.xml
> >
> commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/keyvalue/MultiKey.java
> >
> > Modified: commons/proper/collections/trunk/src/changes/changes.xml
> > URL:
> http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/changes/changes.xml?rev=1632886&r1=1632885&r2=1632886&view=diff
> >
> ==============================================================================
> > --- commons/proper/collections/trunk/src/changes/changes.xml (original)
> > +++ commons/proper/collections/trunk/src/changes/changes.xml Sun Oct 19
> 10:10:45 2014
> > @@ -22,6 +22,9 @@
> > <body>
> >
> > <release version="4.1" date="TBD" description="">
> > + <action issue="COLLECTIONS-535" dev="britter" type="update"
> due-to="Alexander Kjäll">
> > + Clarify JavaDoc of MultiKey getKey() and size()
> > + </action>
> > <action issue="COLLECTIONS-529" dev="tn" type="add"
> due-to="Alexander Muthmann, Dipanjan Laha">
> > Added methods "removeAll(...)" and "retainAll(...)" to
> "CollectionUtils" that perform
> > equality checks using the provided "Equator" object instead of
> "Object#equals()".
> >
> > Modified:
> commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/keyvalue/MultiKey.java
> > URL:
> http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/keyvalue/MultiKey.java?rev=1632886&r1=1632885&r2=1632886&view=diff
> >
> ==============================================================================
> > ---
> commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/keyvalue/MultiKey.java
> (original)
> > +++
> commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/keyvalue/MultiKey.java
> Sun Oct 19 10:10:45 2014
> > @@ -182,7 +182,8 @@ public class MultiKey<K> implements Seri
> > }
> >
> > /**
> > - * Gets the key at the specified index.
> > + * Gets the key at the specified index.
> > + * The index enumeration starts at 0.
>
> This is the default in the java language and does not need explicit
> mentioning imho.
>
> > * <p>
> > * The key should be immutable.
> > * If it is not then it must not be changed.
> > @@ -197,7 +198,7 @@ public class MultiKey<K> implements Seri
> > }
> >
> > /**
> > - * Gets the size of the list of keys.
> > + * Gets the size of the list of keys, this number is the number of
> values this object was created with.
>
> this comment just adds more confusion, and I fail to see how the
> original comment needs more clarification as the description is pretty
> clear to me.
>
> > *
> > * @return the size of the list of keys
> > * @since 3.1
> >
> >
>
> Thomas
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> For additional commands, e-mail: dev-help@commons.apache.org
>
>
--
http://people.apache.org/~britter/
http://www.systemoutprintln.de/
http://twitter.com/BenediktRitter
http://github.com/britter