commit	666faa8d6d66c60c69fdbcef3cacf32b54f0b0dc	[log] [tgz]
author	Tatu Saloranta <tatu.saloranta@iki.fi>	Wed Aug 09 19:52:41 2017 -0700
committer	Tatu Saloranta <tatu.saloranta@iki.fi>	Wed Aug 09 19:52:41 2017 -0700
tree	661c2eaf8175ca4ba08ad9697ce0e4aadff76e8d
parent	21c02827658b19796e3ec85f5ed687fa6fa9e5e2 [diff]

tree: 661c2eaf8175ca4ba08ad9697ce0e4aadff76e8d

README.md

Overview

This project contains core low-level incremental ("streaming") parser and generator abstractions used by Jackson Data Processor. It also includes the default implementation of handler types (parser, generator) that handle JSON format. The core abstractions are not JSON specific, although naming does contain 'JSON' in many places, due to historical reasons. Only packages that specifically contain word 'json' are JSON-specific.

This package is the base on which Jackson data-binding package builds on. It is licensed under Apache License 2.0. For additional/alternative licensing questions, please contact info@fasterxml.com: affordable commercial licenses available for use cases like Android app development.

Alternate data format implementations (like Smile (binary JSON), XML, CSV) and CBOR also build on this base package, implementing the core interfaces, making it possible to use standard data-binding package regardless of underlying data format.

Project contains versions 2.0 and above: source code for earlier (1.x) versions is available from Codehaus SVN repository.

Get it!

Maven

Functionality of this package is contained in Java package com.fasterxml.jackson.core.

To use the package, you need to use following Maven dependency:

<dependency>
  <groupId>com.fasterxml.jackson.core</groupId>
  <artifactId>jackson-core</artifactId>
  <version>${jackson-core-version}</version>
</dependency>

or download jars from Maven repository or links on Wiki. Core jar is a functional OSGi bundle, with proper import/export declarations.

Package has no external dependencies, except for testing (which uses JUnit).

Non-Maven

For non-Maven use cases, you download jars from Central Maven repository or Wiki.

Core jar is also a functional OSGi bundle, with proper import/export declarations, so it can be use on OSGi container as is.

Use it!

General

Usage typically starts with creation of a reusable (and thread-safe, once configured) JsonFactory instance:

JsonFactory factory = new JsonFactory();
// configure, if necessary:
factory.enable(JsonParser.Feature.ALLOW_COMMENTS);

Alternatively, you have a ObjectMapper (from Jackson Databind package) handy; if so, you can do:

JsonFactory factory = objectMapper.getFactory();

More information can be found from Streaming API at Jackson Wiki.

Usage, simple reading

All reading is by using JsonParser (or its sub-classes, in case of data formats other than JSON), instance of which is constructed by JsonFactory.

An example can be found from Reading and Writing Event Streams

Usage, simple writing

All writing is by using JsonGenerator (or its sub-classes, in case of data formats other than JSON), instance of which is constructed by JsonFactory: