Skip to content

A quick to use Android library compatible all the way down to API 3, to download a JSON and convert it into a UTF-8 encoded JSON object.

License

Notifications You must be signed in to change notification settings

hassie-dash/hson

Repository files navigation

HSON

Build Status Codacy Badge Download

HSON is a quick to use Android library which converts a json file from a network response to a JSON object with UTF-8 encoding as standard, ensuring that all those special characters are present in the JSON object.

HSON greatly simplifies the process as HSON handles all the networking, the conversion of the network response to a string and the conversion of the string to a UTF-8 encoded JSON object. The library uses the HttpUrlConnection class to ensure maximal compatibility.

HSON also provides a conversion class which converts any json string to a UTF-8 encoded JSON object.

The minimum API required for this library is API 3.

Screenshots

Dependencies

To use the library, add the dependency to your app module's build.grade file:

dependencies {
    compile fileTree(dir: 'libs', include: ['*.jar'])
    
    // Add this dependency.
    compile 'uk.co.hassie:hson:0.0.2'
}

HSON Downloader example

new HSON.Downloader()
    .setURL("https://raw.githubusercontent.com/hassie-dash/hson/master/sample_json.json")
    .download(new Callback.DownloadCallback() {
        @Override
        public void onStart() {
            // Do any work required before the download is started ie. showing a progress dialog.
        }
        @Override
        public void onFinish(JSONObject json) {
            // JSON download successful. Do work with JSON here.
        }
        @Override
        public void onFail() {
            // JSON download failed. Handle error here if required.
        }
    });

Note: All callback methods must be overidden but can be left blank.

HSON Converter example

String jsonString = "some JSON string";

new HSON.Converter()
    .setString(jsonString)
    .convert(new Callback.ConversionCallback() {
        @Override
        public void onStart() {
            // Do any work required before the conversion is started ie. showing a progress dialog.
        }
        @Override
        public void onFinish(JSONObject json) {
            // JSON conversion successful. Do work with JSON here.
        }
        @Override
        public void onFail() {
            // JSON conversion failed. Handle error here if required.
        }
    });

Note: All callback methods must be overidden but can be left blank.

Methods

  • HSON.Downloader
    • setURL(param) - The URL of the JSON to download and convert to a JSON object. Can either be a string or a string resource.
    • download(Callback.DownloadCallback) - Start the download. A download callback is required as the parameter.
  • HSON.Converter
    • setString(String) - The string to be converted to a JSON object. Must be a string.
    • convert(Callback.ConversionCallback) - Start the conversion. A conversion callback is required as the parameter.

License

Copyright ©2017 Hassie.

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.

About

A quick to use Android library compatible all the way down to API 3, to download a JSON and convert it into a UTF-8 encoded JSON object.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages