-
-
Notifications
You must be signed in to change notification settings - Fork 221
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.
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
Add mechanism for processing invalid XML names (transforming to valid ones) #531
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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 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 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 |
---|---|---|
|
@@ -108,6 +108,14 @@ public Builder defaultUseWrapper(boolean state) { | |
_mapper.setDefaultUseWrapper(state); | ||
return this; | ||
} | ||
|
||
/** | ||
* @since 2.14 | ||
*/ | ||
public Builder xmlTagProcessor(XmlTagProcessor tagProcessor) { | ||
_mapper.setXmlTagProcessor(tagProcessor); | ||
return this; | ||
} | ||
} | ||
|
||
protected final static JacksonXmlModule DEFAULT_XML_MODULE = new JacksonXmlModule(); | ||
|
@@ -280,6 +288,20 @@ public XmlMapper setDefaultUseWrapper(boolean state) { | |
return this; | ||
} | ||
|
||
/** | ||
* @since 2.14 | ||
*/ | ||
public void setXmlTagProcessor(XmlTagProcessor tagProcessor) { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Let's also remove this mutator; should be passed via |
||
((XmlFactory)_jsonFactory).setXmlTagProcessor(tagProcessor); | ||
} | ||
|
||
/** | ||
* @since 2.14 | ||
*/ | ||
public XmlTagProcessor getXmlTagProcessor() { | ||
return ((XmlFactory)_jsonFactory).getXmlTagProcessor(); | ||
} | ||
|
||
/* | ||
/********************************************************** | ||
/* Access to configuration settings | ||
|
60 changes: 60 additions & 0 deletions
60
src/main/java/com/fasterxml/jackson/dataformat/xml/XmlTagProcessor.java
This file contains 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.xml; | ||
|
||
import java.io.Serializable; | ||
|
||
/** | ||
* XML tag name processor primarily used for dealing with tag names | ||
* containing invalid characters. Invalid characters in tags can, | ||
* for instance, easily appear in map keys. | ||
* <p> | ||
* Processors should be set in the {@link XmlMapper#setXmlTagProcessor(XmlTagProcessor)} | ||
* and/or the {@link XmlMapper.Builder#xmlTagProcessor(XmlTagProcessor)} methods. | ||
* <p> | ||
* See {@link XmlTagProcessors} for default processors. | ||
* | ||
* @since 2.14 | ||
*/ | ||
public interface XmlTagProcessor extends Serializable { | ||
|
||
/** | ||
* Representation of an XML tag name | ||
*/ | ||
class XmlTagName { | ||
public final String namespace; | ||
public final String localPart; | ||
|
||
public XmlTagName(String namespace, String localPart) { | ||
this.namespace = namespace; | ||
this.localPart = localPart; | ||
} | ||
} | ||
|
||
|
||
/** | ||
* Used during XML serialization. | ||
* <p> | ||
* This method should process the provided {@link XmlTagName} and | ||
* escape / encode invalid XML characters. | ||
* | ||
* @param tag The tag to encode | ||
* @return The encoded tag name | ||
*/ | ||
XmlTagName encodeTag(XmlTagName tag); | ||
|
||
|
||
/** | ||
* Used during XML deserialization. | ||
* <p> | ||
* This method should process the provided {@link XmlTagName} and | ||
* revert the encoding done in the {@link #encodeTag(XmlTagName)} | ||
* method. | ||
* <p> | ||
* Note: Depending on the use case, it is not always required (or | ||
* even possible) to reverse an encoding with 100% accuracy. | ||
* | ||
* @param tag The tag to encode | ||
* @return The encoded tag name | ||
*/ | ||
XmlTagName decodeTag(XmlTagName tag); | ||
|
||
} |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unless something in setup requires this, let's leave out this mutator: being a new feature should be possible to just use Builder approach. 3.0 (master) will have to remove it otherwise.