Skip to content

Latest commit

 

History

History
89 lines (61 loc) · 2.84 KB

README.md

File metadata and controls

89 lines (61 loc) · 2.84 KB

Android Arsenal
#Pearl

Pearl is a powerful image caching and loading library. Developers can even save JSON data in the form of objects and can retrieve them later on if they want to display content in offline mode.
Pearl uses concepts of Google's volley project and some of it's own image optimization algorithms to display the most vibrant and pixel rich image. It's light, cleaner and is maintained by the open source community itself.

#Download
###Using Gradle: under dependencies section:

compile 'com.github.hanuor:pearl:0.0.8'    

or Using Maven:

<dependency>
<groupId>com.github.hanuor</groupId>
<artifactId>pearl</artifactId>
<version>0.0.8</version>
<type>pom</type>
</dependency>

#Documentation

###Loading an Image For now a premium fade in animation has been integrated into the library. Images will be displayed through fade in animation.

 Pearl.imageLoader(Context mContext,String URLofImage,ImageView imageView,int defaultImage);  

where
mcontext = Context of the activity/fragment
URLofImage = Url of image to be downloaded from web
imageView = Target ImageView

###Saving a Json object

Pearl.saveJsonObject(Context context, String jsonObject,String tag);     

You have to convert Json object into a String first.

###Retrieving a Json String

Object retrieve = Pearl.retrieveJsonObject(String tag);     
String retString = retrieve.toString();     

###Cancel an image load

Pearl.cancelImageLoad(String urlofImage)    

###Compatibility

Minimum Android SDK: Pearl requires a minimum API level of 10.


###Special thanks to:

Google's volley for android
Apache httpcore.jar
Apache httpclient.jar
Rohan Dikshit (Website)
Shantanu Johri (Android)


###How it looks like?
Pearl demo app


###License Copyright 2016 Hanuor, Inc.

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.