• Home
• io.helidon.metadata
• helidon-metadata-hson
• 4.1.0
• source code
• package-info.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

io.helidon.metadata.hson.package-info Maven / Gradle / Ivy

/*
 * Copyright (c) 2024 Oracle and/or its affiliates.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * Tiny HSON parser and writer. This is intended for annotation processors, code generators,
 * and readers of the generated files, such as Config Metadata, Service Registry etc.
 * 

 * To write HSON (compatible with JSON), start with either of the following types:
 * 

 *     
{@link io.helidon.metadata.hson.Hson.Array}
 *     
{@link io.helidon.metadata.hson.Hson.Struct}
 * 
 * To read HSON, start with {@link io.helidon.metadata.hson.Hson#parse(java.io.InputStream)}.
 * 

 * Supported features, non-features:
 * 

 *     
Only UTF-8 is supported
 *     
Arrays
 *     
Structs (Same as JsonObject from JSON-P in semantics)
 *     
Nesting of structs and arrays
 *     
String, BigDecimal, boolean, null
 *     
No pretty print (always writes as small as possible)
 *     
Keeps order of insertion on write
 *     
Keeps order of original HSON on read
 *     
Can read unicode escaped characters ({@code \ u0000}), but not write them
 *     
Maximal value size is 64000 bytes
 *     
Maximal HSON size is unlimited - NEVER USE WITH OVER-THE-NETWORK PROVIDED HSON
 * 
 *
 * Should you use this library?
 * No, unless:
 * 

 *     
You are developing writing or parsing of metadata in Helidon codegen or runtime for Helidon features,
 *     the metadata must be produced by Helidon as well (NEVER USE ON OVER-THE-NETWORK PROVIDED HSON)
 *     
You are a brave user who wants to do something similar in their library
 * 
 * NOTE: HSON is compatible with JSON, with the limitations mentioned in the list
 * above. This module is not Helidon JSON solution - please use one of the supported JSON libraries,
 * such as JSON-P, JSON-B, or Jackson.
 * 

 * WARNING: The HSON value is always fully read into memory
 */
package io.helidon.metadata.hson;