https://github.com/hjson/hjson-java

Hjson for Java
https://github.com/hjson/hjson-java

hjson java

Last synced: 3 days ago
JSON representation

Hjson for Java

• Host: GitHub
• URL: https://github.com/hjson/hjson-java
• Owner: hjson
• License: mit
• Created: 2015-04-14T18:50:29.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2023-10-14T16:17:38.000Z (about 1 year ago)
• Last Synced: 2024-11-07T06:13:26.798Z (10 days ago)
• Topics: hjson, java
• Language: Java
• Homepage: https://hjson.github.io/
• Size: 226 KB
• Stars: 159
• Watchers: 12
• Forks: 24
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: history.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# hjson-java

[![Build Status](https://github.com/hjson/hjson-java/workflows/test/badge.svg)](https://github.com/hjson/hjson-java/actions)

[![Maven Central](https://img.shields.io/maven-central/v/org.hjson/hjson.svg?style=flat-square)](http://search.maven.org/#search|ga|1|g%3A%22org.hjson%22%20a%3A%22hjson%22)

[![Javadoc](https://img.shields.io/badge/Javadoc-blue)](http://www.javadoc.io/doc/org.hjson/hjson)

[Hjson](https://hjson.github.io), the Human JSON. A configuration file format for humans. Relaxed syntax, fewer mistakes, more comments.

![Hjson Intro](https://hjson.github.io/hjson1.gif)

```

{

  # specify rate in requests/second (because comments are helpful!)

  rate: 1000

  // prefer c-style comments?

  /* feeling old fashioned? */

  # did you notice that rate doesn't need quotes?

  hey: look ma, no quotes for strings either!

  # best of all

  notice: []

  anything: ?

  # yes, commas are optional!

}

```

The Java implementation of Hjson is based on [minimal-json](https://github.com/ralfstx/minimal-json). For other platforms see [hjson.github.io](https://hjson.github.io).

# CLI

You can install the Hjson command line tool by downloading and unpacking the latest [*hjson.zip*](https://github.com/hjson/hjson-java/releases).

- run `hjson -h` for help

- `hjson file.json` will convert to Hjson.

- `hjson -j file.hjson` will convert to JSON.

# Install from Maven Central

## Gradle

Add a dependency to your `build.gradle`:

```

dependencies {

  compile 'org.hjson:hjson:3.1.0'

}

```

## Maven

Add a dependency to your `pom.xml`:

```xml

  org.hjson

  hjson

  3.1.0

```

## Ivy

Add a dependency to your `ivy.xml`:

```xml

  

```

# Usage

You can either

- use this libary directly

- or just convert Hjson to JSON and use it with your *favorite JSON library*.

### Convert

```java

// convert Hjson to JSON

String jsonString = JsonValue.readHjson(readerOrHjsonString).toString();

// convert JSON to Hjson

String hjsonString = JsonValue.readHjson(readerOrJSONString).toString(Stringify.HJSON);

```

### Read

```java

JsonObject jsonObject = JsonValue.readHjson(string).asObject();

JsonArray jsonArray = JsonValue.readHjson(reader).asArray();

```

`JsonValue.readHjson()` will accept both Hjson and JSON. You can use `JsonValue.readJSON()` to accept JSON input only.

### Object sample

```java

String name = jsonObject.get("name").asString();

int age = jsonObject.get("age").asInt(); // asLong(), asFloat(), asDouble(), ...

// or iterate over the members

for (Member member : jsonObject) {

  String name = member.getName();

  JsonValue value = member.getValue();

  // ...

}

```

### Array sample

```java

String name = jsonArray.get(0).asString();

int age = jsonArray.get(1).asInt(); // asLong(), asFloat(), asDouble(), ...

// or iterate over the values

for(JsonValue value : jsonArray) {

  // ...

}

```

### Nested sample

```java

// Example: { "friends": [ { "name": "John", "age": 23 }, ... ], ... }

JsonArray friends = jsonObject.get("friends").asArray();

String name = friends.get(0).asObject().get("name").asString();

int age = friends.get(0).asObject().get("age").asInt();

```

### Create

```java

JsonObject jsonObject = new JsonObject().add("name", "John").add("age", 23);

// -> { "name": "John", "age", 23 }

JsonArray jsonArray = new JsonArray().add("John").add(23);

// -> [ "John", 23 ]

```

### Modify

```java

jsonObject.set("age", 24);

jsonArray.set(1, 24); // access element by index

jsonObject.remove("age");

jsonArray.remove(1);

```

### Write

Writing is not buffered (to avoid buffering twice), so you *should* use a BufferedWriter.

```java

jsonObject.writeTo(writer);

jsonObject.writeTo(writer, Stringify.HJSON);

```

### toString()

```java

jsonObject.toString(Stringify.HJSON); // Hjson output

jsonObject.toString(Stringify.FORMATTED); // formatted JSON output

jsonObject.toString(Stringify.PLAIN); // plain JSON output, default

jsonObject.toString(); // plain

```

# API

[Documentation](https://hjson.github.io/hjson-java/)

# History

[see history.md](history.md)