Add FlowStyleResolver to enable custom YAML node style resolution #242
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| package com.fasterxml.jackson.dataformat.yaml.util; | ||
|
|
||
| import org.yaml.snakeyaml.DumperOptions; | ||
|
|
||
| /** | ||
| * Helper interface to customize node styles of object and arrays while exporting YAML objects. | ||
| * | ||
| * @see NodeStyle | ||
| * @see #resolveStyle(String) | ||
| */ | ||
| public interface NodeStyleResolver { | ||
|
|
||
| /** | ||
| * Defines which style to apply to a given object or array. | ||
| * | ||
| * @see DumperOptions.FlowStyle | ||
| * @see <a href="http://www.yaml.org/spec/current.html#id2509255">3.2.3.1. | ||
| * Node Styles (http://yaml.org/spec/1.1)</a> | ||
| */ | ||
| enum NodeStyle { | ||
| /** | ||
| * Block style. i.e. | ||
| * <pre> | ||
| * foo: | ||
| * - bar | ||
| * </pre> | ||
| * <pre> | ||
| * key: | ||
| * foo: bar | ||
| * </pre> | ||
| */ | ||
| BLOCK, | ||
| /** | ||
| * Flow style. i.e. | ||
| * <pre> | ||
| * foo: [bar] | ||
| * </pre> | ||
| * <pre> | ||
| * key: {foo: bar} | ||
| * </pre> | ||
| */ | ||
| FLOW; | ||
|
|
||
| public DumperOptions.FlowStyle getSnakeYamlFlowStyle() { | ||
| switch (this) { | ||
| case BLOCK: | ||
| return DumperOptions.FlowStyle.BLOCK; | ||
| case FLOW: | ||
| return DumperOptions.FlowStyle.FLOW; | ||
| default: | ||
| throw new IllegalStateException("Unexpected value: " + this); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| NodeStyleResolver DEFAULT_INSTANCE = new NodeStyleResolver() { | ||
| @Override | ||
| public NodeStyle resolveStyle(String fieldName) { | ||
| // default behaviour uses YAMLGenerator._outputOptions.getDefaultFlowStyle() (currently set to BLOCK) | ||
| return null; | ||
| } | ||
| }; | ||
|
|
||
| /** | ||
| * Resolve a node style for given fieldName. | ||
| * | ||
| * @param fieldName parent field name of the current object or array. can be null if there is no parent field (i.e. | ||
| * typically root object) | ||
| * @return the desired {@link NodeStyle} or null to use default value (currently 'BLOCK') | ||
| */ | ||
| NodeStyle resolveStyle(String fieldName); | ||
|
There was a problem hiding this comment. I realized that instead of passing just At very least I think array and object cases should go to different methods since I think that's relatively common use case. There was a problem hiding this comment. ... just realized I added this note already. Wrt comment I just added above. And looking at this method now, maybe passing the default style is not useful after all (because it would need to be translated etc). Returning |
||
|
|
||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| package com.fasterxml.jackson.dataformat.yaml.ser; | ||
|
|
||
| import com.fasterxml.jackson.databind.ObjectMapper; | ||
| import com.fasterxml.jackson.dataformat.yaml.ModuleTestBase; | ||
| import com.fasterxml.jackson.dataformat.yaml.YAMLFactory; | ||
| import com.fasterxml.jackson.dataformat.yaml.YAMLGenerator; | ||
| import com.fasterxml.jackson.dataformat.yaml.YAMLMapper; | ||
| import com.fasterxml.jackson.dataformat.yaml.util.NodeStyleResolver; | ||
|
|
||
| import static java.util.Collections.singletonList; | ||
| import static java.util.Collections.singletonMap; | ||
|
|
||
| public class CustomNodeStyleTest extends ModuleTestBase { | ||
| static class CustomNodeStyleResolver implements NodeStyleResolver { | ||
| @Override | ||
| public NodeStyle resolveStyle(String fieldName) { | ||
| if (fieldName != null && fieldName.endsWith("_flow")) | ||
| return NodeStyle.FLOW; | ||
| else if (fieldName != null && fieldName.endsWith("_block")) | ||
| return NodeStyle.BLOCK; | ||
| else | ||
| return null; | ||
| } | ||
| } | ||
|
|
||
| private final ObjectMapper REGULAR_MAPPER = YAMLMapper.builder() | ||
| .enable(YAMLGenerator.Feature.MINIMIZE_QUOTES) | ||
| .disable(YAMLGenerator.Feature.WRITE_DOC_START_MARKER) | ||
| .build(); | ||
|
|
||
| private final YAMLMapper CUSTOM_MAPPER = YAMLMapper.builder( | ||
| YAMLFactory.builder() | ||
| .nodeStyleResolver(new CustomNodeStyleResolver()) | ||
| .build()) | ||
| .enable(YAMLGenerator.Feature.MINIMIZE_QUOTES) | ||
| .disable(YAMLGenerator.Feature.WRITE_DOC_START_MARKER) | ||
| .build(); | ||
|
|
||
| public void testFlowStyles() throws Exception { | ||
| // list | ||
| assertEquals("key_flow: [value]", | ||
| _asYaml(CUSTOM_MAPPER, singletonMap("key_flow", singletonList("value")))); | ||
| assertEquals("key_block:\n- value", | ||
| _asYaml(CUSTOM_MAPPER, singletonMap("key_block", singletonList("value")))); | ||
| assertEquals("key_default:\n- value", | ||
| _asYaml(REGULAR_MAPPER, singletonMap("key_default", singletonList("value")))); | ||
|
|
||
| // object | ||
| assertEquals("key_flow: {foo: bar}", | ||
| _asYaml(CUSTOM_MAPPER, singletonMap("key_flow", singletonMap("foo", "bar")))); | ||
| assertEquals("key_block:\n foo: bar", | ||
| _asYaml(CUSTOM_MAPPER, singletonMap("key_block", singletonMap("foo", "bar")))); | ||
| assertEquals("key_default:\n foo: bar", | ||
| _asYaml(REGULAR_MAPPER, singletonMap("key_default", singletonMap("foo", "bar")))); | ||
| } | ||
|
|
||
| private String _asYaml(ObjectMapper mapper, Object value) throws Exception { | ||
| return mapper.writeValueAsString(value).trim(); | ||
| } | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.