[jira] [Commented] (COLLECTIONS-697) JavaDoc for FixedSizeList should warn that modifying underlying list is still allowed and is not prevented

[ASF GitHub Bot (JIRA)]

    [ 
https://issues.apache.org/jira/browse/COLLECTIONS-697?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16636783#comment-16636783
 ] 

ASF GitHub Bot commented on COLLECTIONS-697:
--------------------------------------------

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


> JavaDoc for FixedSizeList should warn that modifying underlying list is still 
> allowed and is not prevented
> ----------------------------------------------------------------------------------------------------------
>
>                 Key: COLLECTIONS-697
>                 URL: https://issues.apache.org/jira/browse/COLLECTIONS-697
>             Project: Commons Collections
>          Issue Type: Bug
>            Reporter: Ranjan George
>            Priority: Major
>
> 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.
> Following is a test case that written that you could use to check this.
> {code:java}
> public void testAllowsMutationOfUnderlyingCollection() {
>  List<String> decoratedList = new ArrayList<>();
>  decoratedList.add("item 1");
>  decoratedList.add("item 2");
>  //
>  FixedSizeList<String> fixedSizeList = 
> FixedSizeList.fixedSizeList(decoratedList);
>  int sizeBefore = fixedSizeList.size();
>  //
>  boolean changed = decoratedList.add("New Value");
>  Assert.assertTrue(changed);
>  //
>  Assert.assertEquals("Modifying an the underlying list is allowed", 
> sizeBefore + 1, fixedSizeList.size());
> }
> {code}



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)