[GitHub] commons-collections pull request #55: COLLECTIONS-697 Added relevant JavaDoc...

[george-ranjan]

GitHub user george-ranjan opened a pull request:

https://github.com/apache/commons-collections/pull/55

COLLECTIONS-697 Added relevant JavaDoc and a test which proves

I just noticed that it is not explicitly mentioned in the JavaDoc that modifying the underlying list of a FixedSizeList would actually land up modifying the list of the constructed FixedSizeList. Not sure if this was by design, but at the very list I think the JavaDoc should caution against this.

This Pull Request has the necessary updates to the JavaDoc and a test that proves the findings.

NOTE: this is my first PR and I have tried to follow the guidelines. Pleas let me know if I need to do anything more. Thanks!

You can merge this pull request into a Git repository by running:

$ git pull https://github.com/george-ranjan/commons-collections COLLECTIONS-697_FixedSizeList

Alternatively you can review and apply these changes as the patch at:

https://github.com/apache/commons-collections/pull/55.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

This closes #55

----
commit 1517ed304eef7737b7175a997d77cca384be8631
Author: george-ranjan <***@...>
Date: 2018-10-02T17:44:07Z

COLLECTIONS-697 Added relevant JavaDoc and a test which proves

----


---

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-***@commons.apache.org
For additional commands, e-mail: dev-***@commons.apache.org

[grimreaper]

Github user grimreaper commented on a diff in the pull request:

https://github.com/apache/commons-collections/pull/55#discussion_r222264747

--- Diff: src/main/java/org/apache/commons/collections4/list/FixedSizeList.java ---
@@ -31,6 +31,12 @@
* The add, remove, clear and retain operations are unsupported.
* The set method is allowed (as it doesn't change the list size).
* <p>
+ * <p>
--- End diff --

extra `<p>`


---

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-***@commons.apache.org
For additional commands, e-mail: dev-***@commons.apache.org

[grimreaper]

Github user grimreaper commented on a diff in the pull request:

https://github.com/apache/commons-collections/pull/55#discussion_r222264719

--- Diff: src/test/java/org/apache/commons/collections4/list/FixedSizeListTest.java ---
@@ -66,4 +68,20 @@ public String getCompatibilityVersion() {
// writeExternalFormToDisk((java.io.Serializable) getCollection(), "src/test/resources/data/test/FixedSizeList.fullCollection.version4.obj");
// }

+
--- End diff --

extra newline


---

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-***@commons.apache.org
For additional commands, e-mail: dev-***@commons.apache.org

[george-ranjan]

Github user george-ranjan commented on the issue:

https://github.com/apache/commons-collections/pull/55

@grimreaper fixed & pushed.


---

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-***@commons.apache.org
For additional commands, e-mail: dev-***@commons.apache.org

[grimreaper]

Github user grimreaper commented on the issue:

https://github.com/apache/commons-collections/pull/55

cool. Now we're waiting for INFRA-17094.


---

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-***@commons.apache.org
For additional commands, e-mail: dev-***@commons.apache.org

[asfgit]

Github user asfgit closed the pull request at:

https://github.com/apache/commons-collections/pull/55


---

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-***@commons.apache.org
For additional commands, e-mail: dev-***@commons.apache.org

[asfgit]

Github user asfgit closed the pull request at:

https://github.com/apache/commons-collections/pull/55


---

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-***@commons.apache.org
For additional commands, e-mail: dev-***@commons.apache.org