[jira] [Comment Edited] (CALCITE-4254) ImmutableBeans should make an immutable copy of property values of type List, Set, or Map

["Vladimir Sitnikov (Jira)" <ji...@apache.org>]

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

Vladimir Sitnikov edited comment on CALCITE-4254 at 9/14/20, 5:27 PM:
----------------------------------------------------------------------

Julian, what do you think ofrenaming {{makeImmutable}} attribute to {{mutable}}, so the use becomes {{makeMutable=true}} rather than {{immutable=false}}?

---

One more idea might be to use Java 1.8 type annotations, so the declaration might be like

{code:java}
@ImmutableBean.Property
@Mutable List<Integer> getNumbers();
{code}

A nice consequence would be the same design might work for cases like {code:java}Map<String, @Mutable List<String>>{code}, and, more important, {{@Mutable}} annotations would be visible in the IDE, so users see that the list is mutable or not.



was (Author: vladimirsitnikov):
Julian, what do you think ofrenaming {{makeImmutable}} attribute to {{mutable}}, so the use becomes {{makeMutable=true}} rather than {{immutable=false}}?

Just in case, another idea might be Java 1.8 type annotations, so the declaration might be like

{code:java}
@ImmutableBean.Property
@Mutable List<Integer> getNumbers();
{code}

A nice consequence would be the same design might work for cases like {code:java}Map<String, @Mutable List<String>>{code}, and, more important, {{@Mutable}} annotations would be visible in the IDE, so users see that the list is mutable or not.


> ImmutableBeans should make an immutable copy of property values of type List, Set, or Map
> -----------------------------------------------------------------------------------------
>
>                 Key: CALCITE-4254
>                 URL: https://issues.apache.org/jira/browse/CALCITE-4254
>             Project: Calcite
>          Issue Type: Bug
>            Reporter: Julian Hyde
>            Assignee: Julian Hyde
>            Priority: Major
>
> {{ImmutableBeans}} should make an immutable copy of values of type {{List}}, {{Set}} or {{Map}} when they are provided via a setter method. For example, this is how it should work:
> {code:java}
> MyBean bean = ImmutableBeans.create(MyBean.class);
> List<Integer> evens = Arrays.asList(2, 4, 6);
> bean = bean.withNumbers(evens);
> assertThat(bean.getNumbers(), equalTo(evens));
> assertThat(bean.getNumbers(), isInstanceOf(ImmutableList.class));
> {code}
> Note that {{evens}} has been converted to an {{ImmutableList}} with the same contents.
> You can control this behavior by setting {{makeImmutable = false}} when you declare the property:
> {code:java}
> interface MyBean {
>   @ImmutableBean.Property(makeImmutable = false)
>   List<Integer> getNumbers();
>   MyBean withNumbers(List<Integer> numbers);
> }
> {code}
> By default, {{makeImmutable}} is true. This will change behavior of a very few existing beans that were assuming that the value that was put in would be the value that came out (see a couple of changes in {{VolcanoPlannerTest}}), but for the vast majority, immutability is the desired behavior.



--
This message was sent by Atlassian Jira
(v8.3.4#803005)