Skip to content

README.md

Latest commit

 

History

History
92 lines (65 loc) · 2.7 KB

README.md

File metadata and controls

92 lines (65 loc) · 2.7 KB

Json-Java logo

JSON in Android [package android.org.json]

A port of the JSON-Java library specifically refactored for Android development.

Overview

The original JSON-Java library is widely used for JSON parsing and manipulation in Java applications. However, it has compatibility issues when used in Android environments due to package conflicts and platform differences.

This repository provides a forked and refactored version of the JSON-Java library with a changed package name to avoid conflicts on Android. This allows Android developers to seamlessly integrate JSON handling capabilities without worrying about clashes with other libraries or the Android runtime.

Features

  • Fully compatible with Android development environments.
  • Refactored package namespace to prevent conflicts.
  • Maintains the original functionality and API of JSON-Java.
  • Easy to integrate into Android projects.

💉Implimentation

Gradle :-

Add it in your root build.gradle at the end of repositories:

	allprojects {
		repositories {
			...
			maven { url 'https://jitpack.io' }
		}
	}

Step 2. Add the dependency

	dependencies {
	        implementation 'com.github.Errorxcode:json-android:1.0'
	}

Maven :-

Step 1. Add to project level file

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

Step 2. Add the dependency

	<dependency>
	    <groupId>com.github.Errorxcode</groupId>
	    <artifactId>json-android</artifactId>
	    <version>1.0</version>
	</dependency>

Usage

Use the library as you would the original JSON-Java library, but with the updated package name to avoid conflicts.

// Example usage
import com.yournewpackage.json.JSONObject;

JSONObject obj = new JSONObject();
obj.put("key", "value");
System.out.println(obj.toString());

Why This Fork?

The original JSON-Java library uses a package name that can conflict with other libraries or Android system classes, causing build or runtime issues. By changing the package name, this fork ensures smooth integration and usage within Android apps.

Contributing / Building / Updating

To build or update this library, follow these simple steps:

  • Clone the repository (it is a Gradle project).

  • Update or replace the relevant classes in the src directory with the latest versions from the new JSON-Java release.

  • Rebuild the project using Gradle.

**In a nutshell: all you have to do is copy, paste, and replace the classes in the src folder to update the library.