Skip to content

Latest commit

 

History

History
234 lines (169 loc) · 7.15 KB

README.md

File metadata and controls

234 lines (169 loc) · 7.15 KB
Raw

AppMaster

AppMaster is a laibray for android which helps in creating some of the required files and folder without any hustle.

You can easiy create shared preferences and store data like ArrayList, float, int, string and etc. And to get the instance of a value which always remains constant try to declare them in the Constants.java.

Usage

First, create a new module by right clicking on app folder. Then, select 'Android Library' and name the module 'generator'. After the module is created create a 'Java' file name 'FileGenerator.java'.

Add this line to root folder of your build.gradle.

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

Then add this line to module level build,gradle

implementation 'com.github.Mritunjay10:AppMaster:v1.1'

The completing sync add the following code in 'FileGenerator.java':

   public static void main(String[] args) {

        String PACKAGE = "YOUR_PACKAGE_NAME"; //present in manifest or build.gradle file
        String APP_NAME = " \"YOUR_APP_NAME\" ";

        OperationHelper.execute(PACKAGE, APP_NAME);
    }

After adding the above lines click on the FileGenerator.java and press Ctrl+Shift+F10.

If the code finished with exit code 0 voila you have just create the following files:

|───app  
│
|───helper
│     |───INDIPreferences.java
│   
|───utils
│     |───Constants.java
|
|───INDIMaster.java

Make sure after creating the folders you refract all the activity inside the app folder.

And change the appliction name to .INDIMaster in manifest file as shown below:

 <application
        android:name=".INDIMaster"
        ...

How it works

The function of Constants.java file is to store static String, float, int, array values, for e.g:

String APP_URL = 'http://www.your_url.com'; /// String is defined in Constants.java

And, to access the reference just add implements Constants to any class.

Here, INDIMaster is a Application class which defines the overall properties of the application. In, INDIMaster.java I have already defined a function getInstance() which allows you to access the application context in the entire application just type INDIMaster.getInstance() and it will return you the application context.

But, make sure to change the appliction name to .INDIMaster in manifest file as shown below:

 <application
        android:name=".INDIMaster"
        ...

else, it will throw an error and application will keep crashing.

Now, for INDIPreferences.java which is a handler class for shared preferences. It will help you to access shared preferences without long and pathetic code. Look at the examples below:

Now, to save a String, int and boolean value you have to call the below functions:

  INDIPreferences.saveString("Your value", "UNIQUE_STRING_KEY_TO_RETRIVE");
  INDIPreferences.saveInt(0, "UNIQUE_INT_KEY_TO_RETRIVE");
  INDIPreferences.saveBoolean(true, "UNIQUE_BOOLEAN_KEY_TO_RETRIVE");

And, to get stored data

  INDIPreferences.getString("UNIQUE_STRING_KEY_TO_RETRIVE");
  INDIPreferences.getInt("UNIQUE_INT_KEY_TO_RETRIVE");
  INDIPreferences.getBoolean("UNIQUE_BOOLEAN_KEY_TO_RETRIVE");

For, better understanding of 'UNIQUE_STRING_KEY_TO_RETRIVE' read shared preferences docs.

Like, the above example you can save float, int, string as per your need.

Storing array list

In order to save ArrayList, ArrayList<~> or any list, you have to add the following lines in app level build.gradle:

implementation 'com.google.code.gson:gson:2.8.5'

Then add following function to INDIPreferences.java in order to store ArrayList:

public static void saveArrayListStrings(ArrayList<String> strings, String key) {
    SharedPreferences.Editor editor = getPreferences().edit();
    Gson gson = new Gson();
    String jsonStrings = gson.toJson(strings);
    editor.putString(key, jsonStrings);
    editor.commit();
 }

To, get ArrayList add folllowing function to INDIPreferences.java:

public static ArrayList<String> getArrayListString(String key) {

    SharedPreferences settings = getPreferences();
    List<String> strings;

    if (settings.contains(key)) {
        String jsonSt = settings.getString(key, null);
        Gson gson = new Gson();
        String[] st = gson.fromJson(jsonSt,
                String[].class);

        strings = Arrays.asList(st);
        strings = new ArrayList<String>(strings);
        
        } else
            return null;

        return (ArrayList<String>) strings;
    }

To, access the reference

To save data : INDIPreferences.saveArrayListStrings(customs, "UNIQUE_STRING_KEY_TO_RETRIVE_STRING_ARRAY_DATA");
To get data : INDIPreferences.getArrayListString("UNIQUE_STRING_KEY_TO_RETRIVE_STRING_ARRAY_DATA");

For, storing your custom model ArrayList add following function to INDIPreferences.java:

public static void saveCustomArrayList(ArrayList<Custom> customs, String key) {
    SharedPreferences.Editor editor = getPreferences().edit();
    Gson gson = new Gson();
    String jsonStrings = gson.toJson(customs);
    editor.putString(key, jsonStrings);
    editor.commit();
 }

To, get custom model ArrayList add following function to INDIPreferences.java:

public static ArrayList<Custom> getCustomArrayList(String key) {

   SharedPreferences settings = getPreferences();
   List<Custom> strings;

    if (settings.contains(key)) {
            String jsonSt = settings.getString(key, null);
            Gson gson = new Gson();
            Custom[] st = gson.fromJson(jsonSt,
                    Custom[].class);

            strings = Arrays.asList(st);
            strings = new ArrayList<Custom>(strings);
        } else
            return null;

        return (ArrayList<Custom>) strings;
 }

To, access the reference

To save data : INDIPreferences.saveCustomArrayList(customs, "UNIQUE_STRING_KEY_TO_RETRIVE_DATA");
To get data : INDIPreferences.getCustomArrayList("UNIQUE_STRING_KEY_TO_RETRIVE_DATA");

Contact me

If you have any sugesstion or you have seen any error I would love to listen.
Jsut mail me at mjdemon211@gmail.com or info.indilabz@gmail.com.

Thanks!!

Donation

If this project helps you in anyway, you can give me a cup of coffee :)

paypal

License

Gson is released under the Apache 2.0 license.

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.

Disclaimer

This is developed by Mritunjay (http://indilabz.in/).