Adds a Macroize tool to enable conversion of Ion 1.0 data to Ion 1.1 using specified macros and text patterns. #990
Conversation
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
…using specified macros and text patterns.
tgregg
commented
Nov 11, 2024
| @@ -24,7 +24,7 @@ public abstract class IonEncodingVersion<BinaryWriterBuilder, TextWriterBuilder> | |||
| * Ion 1.0, see the <a href="https://amazon-ion.github.io/ion-docs/docs/binary.html">binary</a> and | |||
| * <a href="https://amazon-ion.github.io/ion-docs/docs/text.html">text</a> specification. | |||
| */ | |||
| public static IonEncodingVersion<IonBinaryWriterBuilder, IonTextWriterBuilder> ION_1_0 = new IonEncodingVersion<IonBinaryWriterBuilder, IonTextWriterBuilder>(0) { | |||
| public static final IonEncodingVersion<IonBinaryWriterBuilder, IonTextWriterBuilder> ION_1_0 = new IonEncodingVersion<IonBinaryWriterBuilder, IonTextWriterBuilder>(0) { | |||
There was a problem hiding this comment.
I'm not sure why Spotless just found these now, but this is a good change, though unrelated to the rest of the PR.
| @@ -21,7 +21,7 @@ | |||
| * in an IndexOutOfBoundsException. The number 10 is chosen because it is the maximum number of bytes required to write | |||
| * a long value as a FlexInt or VarInt. | |||
| */ | |||
| /*package*/ final class WriteBuffer implements Closeable | |||
| public final class WriteBuffer implements Closeable | |||
There was a problem hiding this comment.
This is being used in Macroize, which is in a different Java package. We can rename this class using the _Private_ prefix if we want to maintain the existing convention to denote that this shouldn't be used by users of the library.
Comment on lines
+326
to
+333
| if (((IonValueLite) element)._context.getContextSymbolTable() != getContextForIndex(null, index).getContextSymbolTable()) { | ||
| // Note: this isn't impossible to support, but it requires care in the case where 'element' may depend | ||
| // on symbol table mappings unique to its own context. In order to sidestep this complexity until a use | ||
| // case is identified for it, only setting the element at an index that uses the same symbol table is | ||
| // currently supported. | ||
| throw new UnsupportedOperationException(); | ||
| } | ||
| return super.set(index, element); |
There was a problem hiding this comment.
The JavaDoc for this method still says it's unsupported. I haven't felt the need to change that to mark this as officially supported since it has a known limitation. I'm happy to move this functionality to an internal-only method if we prefer that.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description of changes:
This is an early (
v0.1) version of the tool with many TODOs and known limitations (see the JavaDoc on MacroizeSpec.java). However, I think it's useful enough to make available now while we continue iterating. I also have a version of the tool that does basic macro detection, but that will be added in a future PR.The tool may be invoked by building the ion-java jar and using
java -cp ion-java.jar com.amazon.ion.apps.macroize.MacroizeBy submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.