Skip to content

Commit 8f15995

Browse files
cowtowncodercowtowncoder
committed
Add Ion as standard binary codec
1 parent 598ef8d commit 8f15995

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+4658
-0
lines changed

‎README.md

+1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Currently included are:
77

88
* [Avro](avro/)
99
* [CBOR](cbor/)
10+
* [Ion](ion/)
1011
* [Protobuf](protobuf/)
1112
* [Smile](smile/)
1213

‎ion/LICENSE

+176
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS

‎ion/NOTICE

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
JacksonIon
2+
Copyright 2012-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.

‎ion/README.md

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Overview
2+
3+
[Jackson](/FasterXML/jackson) data format module for reading and writing
4+
[Ion](https://amznlabs.github.io/ion-docs/) encoded data.
5+
6+
Project is licensed under [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt).
7+
8+
# Status
9+
10+
Since version 2.6(.7) this module is considered complete and production ready.
11+
All Jackson layers (streaming, databind, tree model) are supported.
12+
13+
[![Build Status](https://travis-ci.org/FasterXML/jackson-dataformat-ion.svg?branch=master)](https://travis-ci.org/FasterXML/jackson-dataformat-ion)
14+
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.fasterxml.jackson.dataformat/jackson-dataformat-ion/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.fasterxml.jackson.dataformat/jackson-dataformat-ion/)
15+
[![Javadoc](https://javadoc-emblem.rhcloud.com/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-ion/badge.svg)](http://www.javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-ion)
16+
17+
18+
To use this extension on Maven-based projects, use following dependency:
19+
20+
```xml
21+
<dependency>
22+
<groupId>com.fasterxml.jackson.dataformat</groupId>
23+
<artifactId>jackson-dataformat-ion</artifactId>
24+
<version>2.7.9</version>
25+
</dependency>
26+
```
27+
## Usage
28+
29+
Basic usage is by using `IonObjectMapper` instead of basic `ObjectMapper`;
30+
or, if only using streaming parser/generator, `IonFactory` instead of `JsonFactory`.
31+
32+
```java
33+
ObjectMapper mapper = new IonObjectMapper();
34+
// and then read/write data as usual
35+
SomeType value = ...;
36+
byte[] encoded = mapper.writeValueAsBytes(value);
37+
SomeType otherValue = mapper.readValue(data, SomeType.class);
38+
```
39+
40+
## Documentation
41+
42+
See [Wiki](../../wiki) (includes Javadocs)

‎ion/pom.xml

+71
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
3+
<modelVersion>4.0.0</modelVersion>
4+
<parent>
5+
<groupId>com.fasterxml.jackson.dataformat</groupId>
6+
<artifactId>jackson-dataformats-binary</artifactId>
7+
<version>2.9.0.pr4-SNAPSHOT</version>
8+
</parent>
9+
<groupId>com.fasterxml.jackson.dataformat</groupId>
10+
<artifactId>jackson-dataformat-ion</artifactId>
11+
<name>Jackson dataformat: Ion</name>
12+
<packaging>bundle</packaging>
13+
<description>Support for reading and writing Ion ("binary JSON")
14+
encoded data using Jackson abstractions (streaming API, data binding,
15+
tree model)
16+
</description>
17+
<url>http://github.com/FasterXML/jackson-dataformat-ion</url>
18+
19+
<properties>
20+
<packageVersion.dir>com/fasterxml/jackson/dataformat/ion</packageVersion.dir>
21+
<packageVersion.package>${project.groupId}.ion</packageVersion.package>
22+
</properties>
23+
24+
<dependencies>
25+
<!-- actual decoding by core streaming Ion lib -->
26+
<dependency>
27+
<groupId>software.amazon.ion</groupId>
28+
<artifactId>ion-java</artifactId>
29+
<version>1.0.2</version>
30+
</dependency>
31+
32+
<!-- Extends Jackson core, databind -->
33+
<dependency>
34+
<groupId>com.fasterxml.jackson.core</groupId>
35+
<artifactId>jackson-annotations</artifactId>
36+
</dependency>
37+
<dependency>
38+
<groupId>com.fasterxml.jackson.core</groupId>
39+
<artifactId>jackson-core</artifactId>
40+
</dependency>
41+
<dependency>
42+
<groupId>com.fasterxml.jackson.core</groupId>
43+
<artifactId>jackson-databind</artifactId>
44+
</dependency>
45+
46+
<!-- will come from parent pom for later versions -->
47+
<dependency>
48+
<groupId>org.hamcrest</groupId>
49+
<artifactId>hamcrest-all</artifactId>
50+
<version>1.3</version>
51+
<scope>test</scope>
52+
</dependency>
53+
54+
</dependencies>
55+
56+
<build>
57+
<plugins>
58+
<plugin>
59+
<!-- Inherited from oss-base. Generate PackageVersion.java.-->
60+
<groupId>com.google.code.maven-replacer-plugin</groupId>
61+
<artifactId>replacer</artifactId>
62+
<executions>
63+
<execution>
64+
<id>process-packageVersion</id>
65+
<phase>generate-sources</phase>
66+
</execution>
67+
</executions>
68+
</plugin>
69+
</plugins>
70+
</build>
71+
</project>

‎ion/release-notes/CREDITS

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Here are people who have contributed to development of this project:
2+
(version numbers in brackets indicate release in which the problem was fixed)
3+
4+
Tatu Saloranta, [email protected]: co-author

‎ion/release-notes/VERSION

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Project: jackson-dataformat-ion
2+
3+
------------------------------------------------------------------------
4+
= Releases
5+
------------------------------------------------------------------------
6+
7+
2.9.0 (not yet released)
8+
9+
2.8.9 (12-Jun-2017)
10+
11+
No changes since 2.8.8
12+
13+
2.8.8 (04-Apr-2017)
14+
2.7.9 (22-Mar-2017)
15+
2.6.7 (22-Mar-2017)
16+
17+
- The first public releases!

‎ion/src/main/java/com/fasterxml/jackson/dataformat/ion/EnumAsIonSymbolModule.java

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
/*
2+
* Copyright 2012-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License").
5+
* You may not use this file except in compliance with the License.
6+
* A copy of the License is located at:
7+
*
8+
* http://aws.amazon.com/apache2.0/
9+
*
10+
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS,
11+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific
12+
* language governing permissions and limitations under the License.
13+
*/
14+
15+
package com.fasterxml.jackson.dataformat.ion;
16+
17+
import com.fasterxml.jackson.databind.module.SimpleModule;
18+
19+
/**
20+
* Module that causes all enums to be serialized as Ion symbols.
21+
*/
22+
public class EnumAsIonSymbolModule extends SimpleModule {
23+
private static final long serialVersionUID = 1L;
24+
25+
public EnumAsIonSymbolModule() {
26+
super("EnumAsIonSymbolModule", PackageVersion.VERSION);
27+
addSerializer(new EnumAsIonSymbolSerializer());
28+
}
29+
}

0 commit comments

Comments
 (0)