EL map lookup using string key containing single quote - spring

Question

I have a Java HashMap<String,String> that is being provided to a JSP page (itemTypesByKey) via a ModelAndView from Spring, and a separate structure containing a list of keys. (These keys may or may not result in a valid lookup.) I enumerate over these keys, and snag values from the map.
Map<String, String> itemTypes = new HashMap<>();
itemTypes.put("NormalValue", "INGREDIENT");
itemTypes.put("Apostro'Value", "INGREDIENT");
ModelAndView mav = ...
mav.addObject("itemTypesByKey", itemTypes);
The problem I'm seeing, is that if my key contains an apostrophe, the lookup fails.
My code (for debugging purposes):
Key Name: ${currentKeyName}
Not Empty: ${not empty itemTypesByKey[currentKeyName]}
Type: ${itemTypesByKey[currentKeyName]}
All Suite Types: ${itemTypesByKey}
Ends up printing, for two separate keys:
Key Name: NormalValue
Not Empty: true
Type: INGREDIENT
All Suite Types: {NormalValue=INGREDIENT, Apostro'Value=INGREDIENT}
Key Name: Apostro'Value
Not Empty: false
Type:
All Suite Types: {NormalValue=INGREDIENT, Apostro'Value=INGREDIENT}
I understand escaping apostrophe literals when they're used to lookup a value, but why does this fail if my key contains an apostrophe? How can I safely perform a lookup in my map regardless of whether the value of my key contains special characters?
Edit: I'm using Spring version 3.1.4 (mvc, expression, etc.), and this issue does not affect keys containing exclamation points, or other special characters I could think to test.

Answer 1

Below are some tests alongside results. In order to use an apostrophe inside of a key you have to use two single quotes. On top of that, a key that has a single quote in it or special characters (exclamation, double quotes, etc...) needs to have single quotes surrounding it. Bottom line is surround your keys with single quotes & use two single quotes if you have a single quote in your key.
public static void main(String[] args) {
ExpressionParser parser = new SpelExpressionParser();
Map<String,String> itemTypes = (Map) parser.parseExpression("{NormalValue:'INGREDIENT',ApostroValue:'INGREDIENT'}").getValue();
for (Map.Entry<String, String> e : itemTypes.entrySet())
System.out.println(e.getKey() + ": " + e.getValue());
}
Prints keys & values fine
parseExpression("{NormalValue:'INGREDIENT',Apostro'Value:'INGREDIENT'}")
Exception in thread "main" org.springframework.expression.spel.SpelParseException: EL1046E:(pos 51): Cannot find terminating for string
parseExpression("{NormalValue:'INGREDIENT',Apostro''Value:'INGREDIENT'}")
Exception in thread "main" org.springframework.expression.spel.SpelParseException: EL1043E:(pos 33): Unexpected token. Expected 'colon(:)' but was 'literal_string'
parseExpression("{NormalValue:'INGREDIENT','Apostro''Value':'INGREDIENT'}")
Prints fine
parseExpression("{NormalValue:'INGREDIENT',Apostro\"Value:'INGREDIENT'}")
Exception in thread "main" org.springframework.expression.spel.SpelParseException: EL1045E:(pos 33): Cannot find terminating " for string
parseExpression("{NormalValue:'INGREDIENT','Apostro\"Value':'INGREDIENT'}")
Prints fine
parseExpression("{NormalValue:'INGREDIENT',Apostro!Value:'INGREDIENT'}")
Exception in thread "main" org.springframework.expression.spel.SpelParseException: EL1043E:(pos 33): Unexpected token. Expected 'colon(:)' but was 'not(!)'
parseExpression("{NormalValue:'INGREDIENT','Apostro!Value':'INGREDIENT'}")
Prints fine