Jackson Glossary: CharacterEscapes
Package: org.codehaus.jackson.io
Jar: jackson-core
Added in version: 1.8
Role
This abstract class can be implemented, and registered with JsonFactory or JsonGenerator (in former case, will be passed to JsonGenerator instances factory creates), to add custom JSON String escaping functionality at low-level. This can be used to change behavior of standard JSON escaping (using backslash for characters like backslash and double quotes, as well control characters), as well as for adding additional escaping. It is possible, for example, to force escaping of characters that need escaping in XML/HTML, using appropriate escape Strings (ampersand + name for XML/HTML).
Usage
1 JsonFactory f = new JsonFactory();
2 f.setCharacterEscapes(new MyCharacterEscapes());
3 JsonGenerator jgen = f.createJsonGenerator(new File("output.json"), JsonEncoding.UTF8);
4 // and now all JSON String values will be escaped as per settings of "MyCharacterEscapes"
TODO: add example of what "MyCharacterEscapes" could look like. Until then, "src/test/org/codehaus/jackson/impl/TestCustomEscaping.java" in source repository shows basics.
Back to Jackson Term Glossary