Skip to content

GROOVY-12024: add getAt(Map,String) and putAt(Map,String,V) #2580

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
paulk-asert merged 1 commit into from
Jun 9, 2026
+59 −20
Merged

GROOVY-12024: add getAt(Map,String) and putAt(Map,String,V) #2580

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 38 additions & 1 deletion src/main/java/org/codehaus/groovy/runtime/DefaultGroovyMethods.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6724,7 +6724,7 @@
step();
}

void step() {

Check warning on line 6727 in src/main/java/org/codehaus/groovy/runtime/DefaultGroovyMethods.java

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

A "Brain Method" was detected. Refactor it to reduce at least one of the following metrics: LOC from 67 to 64, Complexity from 23 to 14, Nesting Level from 6 to 2, Number of Variables from 9 to 6. 


See more on https://sonarcloud.io/project/issues?id=apache_groovy&issues=AZ5_Bbe2aN_G2AjgNaPm&open=AZ5_Bbe2aN_G2AjgNaPm&pullRequest=2580
outer:
while (!exhausted) {
if (cache.empty()) {
Expand Down Expand Up @@ -7351,6 +7351,24 @@
return self.get(key);
}

/**
* Support the subscript operator for a Map.
* <pre class="language-groovy groovyTestCase">def map = [foo:'bar', class:'baz', empty:'nope']
* assert map['foo'] == 'bar'
* assert map['class'] == 'baz'
* assert map['empty'] == 'nope'
* assert map['properties'] == null // GROOVY-12024
* </pre>
*
* @param self a Map
* @param key a String as a key for the map
* @return the value corresponding to the given key
* @since 6.0.0
*/
public static <V> V getAt(Map<? super String,V> self, String key) {
return self.get(key);
}

/**
* Support the subscript operator for a Bitset
*
Expand Down Expand Up @@ -12950,14 +12968,33 @@
* @param self a Map
* @param key an Object as a key for the map
* @param value the value to put into the map
* @return the value corresponding to the given key
* @return the value
* @since 1.0
*/
public static <K,V> V putAt(Map<K,V> self, K key, V value) {
self.put(key, value);
return value;
}

/**
* A helper method to allow maps to work with subscript operators.
* <pre class="language-groovy groovyTestCase">def map = [:]
* assert map['properties'] == null
* map['properties'] = new Object() // GROOVY-12024
* assert map['properties'] != null
* </pre>
*
* @param self a Map
* @param key an Object as a key for the map
* @param value the value to put into the map
* @return the value
* @since 6.0.0
*/
public static <V> V putAt(Map<? super String,V> self, String key, V value) {
self.put(key, value);
return value;
}

/**
* Support assigning a range of values with a single assignment statement.
*
Expand Down
34 changes: 18 additions & 16 deletions src/test/groovy/groovy/transform/stc/FieldsAndPropertiesSTCTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -765,7 +765,7 @@ class FieldsAndPropertiesSTCTest extends StaticTypeCheckingTestCase {
'Cannot set read-only property: properties'
}

// GROOVY-8074
// GROOVY-8074, GROOVY-12024
@Test
void testMapPropertyAccess6() {
assertScript '''
Expand All @@ -775,23 +775,27 @@ class FieldsAndPropertiesSTCTest extends StaticTypeCheckingTestCase {
def map = new C()
map.put('foo', 11)
assert map.foo == 1
assert map['foo'] == 1
assert map['foo'] == 11
assert map.get('foo') == 11
'''
assertScript """
def map = new ${MapType.name}()
map.put('foo', 11)
assert map.foo == 1
assert map['foo'] == 1
assert map['foo'] == 11
assert map.get('foo') == 11
map.put('bar', 22)
assert map.bar == 22
assert map['bar'] == 22
assert map.get('bar') == 22
map.put('baz', 33)
assert map.baz == 33
assert map['baz'] == 33
assert map.get('baz') == 33
"""
}

// GROOVY-5001, GROOVY-5491, GROOVY-6144
// GROOVY-5001, GROOVY-5491, GROOVY-6144, GROOVY-12024
@Test
void testMapPropertyAccess7() {
String types = '''
Expand All @@ -804,23 +808,21 @@ class FieldsAndPropertiesSTCTest extends StaticTypeCheckingTestCase {
assertScript types + '''
def map = new C()
map.put('a', new A())
assert map.a != null
assert map.b != null
assert map['a'] != null
assert map['b'] == null
assert map.get('a') != null
assert map.get('b') == null
A a = map.a
B b = map.b
a = map['a']
b = map['b']
assert a instanceof A
assert b instanceof B
'''
assertScript types + '''
def test(C map) {
A a = map.a
B b = map.b
a = map['a']
b = map['b']
assert a instanceof A
assert b instanceof B
assert map.a != null
assert map.b != null
assert map['a'] != null
assert map['b'] == null
assert map.get('a') != null
assert map.get('b') == null
}
test(new C().tap{ put('a', new A()) })
'''
Expand Down
6 changes: 3 additions & 3 deletions src/test/groovy/groovy/transform/stc/GenericsSTCTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2575,7 +2575,7 @@ class GenericsSTCTest extends StaticTypeCheckingTestCase {
def map = new HashMap<String, Integer>()
map['x'] = new Object()
''',
'Cannot assign value of type java.lang.Object to variable of type java.lang.Integer'
'Cannot call','putAt','with arguments [java.util.HashMap<java.lang.String, java.lang.Integer>, java.lang.String, java.lang.Object]'
}

// GROOVY-9069
Expand All @@ -2591,8 +2591,8 @@ class GenericsSTCTest extends StaticTypeCheckingTestCase {
}
}
''',
'Cannot call java.util.Map#put(java.lang.String, java.util.Map<java.lang.String, java.util.List<java.lang.String>>) with arguments [java.lang.String, java.util.LinkedHashMap<java.lang.String, java.util.List<ConfigAttribute>>]',
'Cannot assign java.util.LinkedHashMap<java.lang.String, java.util.List<ConfigAttribute>> to: java.util.Map<java.lang.String, java.util.List<java.lang.String>>'
'Cannot call java.util.Map#put(java.lang.String, java.util.Map<java.lang.String, java.util.List<java.lang.String>>) with arguments [java.lang.String, java.util.LinkedHashMap<java.lang.String, java.util.List<ConfigAttribute>>]',
'Cannot call <V> org.codehaus.groovy.runtime.DefaultGroovyMethods#putAt(java.util.Map<? super java.lang.String, V>, java.lang.String, V) with arguments [java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.util.List<java.lang.String>>>, java.lang.String, java.util.LinkedHashMap<java.lang.String, java.util.List<ConfigAttribute>>]'

assertScript '''
void test(Map<String, Map<String, List<String>>> maps) {
Expand Down
Loading