ADD Fragment usage documentation

Author: rafi0101

README.md

@@ -76,8 +76,8 @@ Usage
 
 * [Properties](#Properties)
 * [Exit Codes](#Exit-Codes)
-* [Example Kotlin](#Example-Kotlin)
-* [Example Java](#Example-Java)
+* [Example Activity (Kotlin and Java)](#Example-Activity-(Kotlin-and-Java))
+* [Example Fragment (Java and Kotlin)](#Example-Fragment-(Kotlin-and-Java))
 
 ### Properties
 
@@ -248,7 +248,9 @@ They can be calles using ```OnCompleteListener.$NAME$```
 | 12        | ```EXIT_CODE_ERROR_STORAGE_PERMISSONS_NOT_GRANTED``` | Storage permissions not granted for custom dialog |
 | 13        | ```EXIT_CODE_ERROR_WRONG_DECRYPTION_PASSWORD```      | Cannot decrypt provided backup file because the password is incorrect |
 
-### Example Kotlin
+### Example Activity (Kotlin and Java)
+
+#### Kotlin
 
 * ##### Backup
 
@@ -291,7 +293,7 @@ They can be calles using ```OnCompleteListener.$NAME$```
             .restore()
     ```
 
-### Example Java
+#### Java
 
 * ##### Backup
 
@@ -326,10 +328,24 @@ They can be calles using ```OnCompleteListener.$NAME$```
     roomBackup.restore();
     ```
 
+### Example Fragment (Kotlin and Java)
+
+##### Kotlin
+
+[`FragmentActivity.kt`](app/src/main/java/de/raphaelebner/roomdatabasebackup/sample/FragmentActivity.kt)  
+[`MainFragment.kt`](app/src/main/java/de/raphaelebner/roomdatabasebackup/sample/MainFragment.kt)
+
+##### Java
+
+[`FragmentActivityJava.java`](app/src/main/java/de/raphaelebner/roomdatabasebackup/sample/FragmentActivityJava.java)  
+[`MainFragmentJava.java`](app/src/main/java/de/raphaelebner/roomdatabasebackup/sample/MainFragmentJava.java)
+
+
 Sample app
 ----------
+
 1. Download this repo
-2. Unzip 
+2. Unzip
 3. Android Studio --> File --> Open --> select this Project
 4. within the app folder you find the sample app
 

app/build.gradle

@@ -53,6 +53,7 @@ dependencies {
     implementation 'androidx.appcompat:appcompat:1.4.0'
     implementation 'androidx.constraintlayout:constraintlayout:2.1.2'
     implementation project(path: ':core')
+    implementation 'androidx.legacy:legacy-support-v4:1.0.0'
     testImplementation 'junit:junit:4.13.2'
     androidTestImplementation 'androidx.test.ext:junit:1.1.3'
     androidTestImplementation 'androidx.test.espresso:espresso-core:3.4.0'

app/src/main/AndroidManifest.xml

@@ -9,7 +9,14 @@
         android:roundIcon="@mipmap/ic_launcher_round"
         android:supportsRtl="true"
         android:theme="@style/AppTheme">
-        <activity android:name=".MainActivity"
+        <activity
+            android:name=".FragmentActivityJava"
+            android:exported="false" />
+        <activity
+            android:name=".FragmentActivity"
+            android:exported="false" />
+        <activity
+            android:name=".MainActivity"
             android:exported="true">
             <intent-filter>
                 <action android:name="android.intent.action.MAIN" />
@@ -21,4 +28,4 @@
         <activity android:name=".MainActivityJava" />
     </application>
 
-</manifest>
+</manifest>

app/src/main/java/de/raphaelebner/roomdatabasebackup/sample/FragmentActivity.kt

@@ -0,0 +1,44 @@
+package de.raphaelebner.roomdatabasebackup.sample
+
+import android.os.Bundle
+import androidx.appcompat.app.AppCompatActivity
+import de.raphaelebner.roomdatabasebackup.core.RoomBackup
+
+/**
+ * MIT License
+ * <p>
+ * Copyright (c) 2021 Raphael Ebner
+ * <p>
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * <p>
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ * <p>
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+class FragmentActivity : AppCompatActivity() {
+
+    lateinit var backup: RoomBackup
+
+    override fun onCreate(savedInstanceState: Bundle?) {
+        super.onCreate(savedInstanceState)
+        setContentView(R.layout.activity_fragment)
+
+        backup = RoomBackup(this)
+
+        val transaction = supportFragmentManager.beginTransaction()
+        transaction.replace(R.id.fragment_container_view, MainFragment())
+        transaction.commit()
+    }
+}

app/src/main/java/de/raphaelebner/roomdatabasebackup/sample/FragmentActivityJava.java

@@ -0,0 +1,48 @@
+package de.raphaelebner.roomdatabasebackup.sample;
+
+import android.os.Bundle;
+
+import androidx.appcompat.app.AppCompatActivity;
+import androidx.fragment.app.FragmentTransaction;
+
+import de.raphaelebner.roomdatabasebackup.core.RoomBackup;
+
+/**
+ * MIT License
+ * <p>
+ * Copyright (c) 2021 Raphael Ebner
+ * <p>
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * <p>
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ * <p>
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+public class FragmentActivityJava extends AppCompatActivity {
+
+    RoomBackup roomBackup;
+
+    @Override
+    protected void onCreate(Bundle savedInstanceState) {
+        super.onCreate(savedInstanceState);
+        setContentView(R.layout.activity_fragment);
+
+        roomBackup = new RoomBackup(this);
+
+        FragmentTransaction transaction = getSupportFragmentManager().beginTransaction();
+        transaction.replace(R.id.fragment_container_view, new MainFragmentJava());
+        transaction.commit();
+    }
+}

app/src/main/java/de/raphaelebner/roomdatabasebackup/sample/MainActivity.kt

@@ -76,6 +76,7 @@ class MainActivity : AppCompatActivity(), FruitListAdapter.OnItemClickListener {
         val btnRestore: Button = findViewById(R.id.btn_restore)
         val btnProperties: Button = findViewById(R.id.btn_properties)
         val btnLanguage: Button = findViewById(R.id.btn_switch_language)
+        val btnFragmentActivity: Button = findViewById(R.id.btn_switch_fragment_activity)
         val btnBackupLocation: Button = findViewById(R.id.btn_backup_location)
         val tvFruits: TextView = findViewById(R.id.tv_fruits)
 
@@ -85,12 +86,13 @@ class MainActivity : AppCompatActivity(), FruitListAdapter.OnItemClickListener {
 
         fruitViewModel = ViewModelProvider(this)[FruitViewModel::class.java]
 
-        fruitViewModel.allFruit.observe(this, { fruits ->
+        fruitViewModel.allFruit.observe(this) { fruits ->
             adapter.submitList(fruits)
-        })
+        }
 
-        tvFruits.text = "Fruits List (Kotlin)"
+        tvFruits.text = "Fruits List (Kotlin Activity)"
         btnLanguage.text = "switch to Java"
+        btnFragmentActivity.text = "switch to Fragment"
 
         val sharedPrefs = "sampleBackup"
         val spEncryptBackup = "encryptBackup"
@@ -112,6 +114,13 @@ class MainActivity : AppCompatActivity(), FruitListAdapter.OnItemClickListener {
             startActivity(intent)
         }
 
+        /*---------------------go to Fragment class--------------------------*/
+        btnFragmentActivity.setOnClickListener {
+            finish()
+            val intent = Intent(this, FragmentActivity::class.java)
+            startActivity(intent)
+        }
+
         var encryptBackup = sharedPreferences.getBoolean(spEncryptBackup, true)
         var storageLocation = sharedPreferences.getInt(spStorageLocation, 1)
         var enableLog = sharedPreferences.getBoolean(spEnableLog, true)

app/src/main/java/de/raphaelebner/roomdatabasebackup/sample/MainActivityJava.java

@@ -100,6 +100,7 @@ protected void onCreate(Bundle savedInstanceState) {
         Button btn_backup = findViewById(R.id.btn_backup);
         Button btn_restore = findViewById(R.id.btn_restore);
         Button btn_language = findViewById(R.id.btn_switch_language);
+        Button btn_fragment_activity = findViewById(R.id.btn_switch_fragment_activity);
         Button btn_properties = findViewById(R.id.btn_properties);
         Button btn_backupLocation = findViewById(R.id.btn_backup_location);
         TextView tvFruits = findViewById(R.id.tv_fruits);
@@ -114,8 +115,9 @@ protected void onCreate(Bundle savedInstanceState) {
 
         fruitViewModel.getAllFruit().observe(this, adapter::submitList);
 
-        tvFruits.setText("Fruits List (Java)");
+        tvFruits.setText("Fruits List (Java Activity)");
         btn_language.setText("switch to Kotlin");
+        btn_fragment_activity.setText("switch to Fragment");
 
         String SHARED_PREFS = "sampleBackup";
         final String spEncryptBackup = "encryptBackup";
@@ -137,6 +139,13 @@ protected void onCreate(Bundle savedInstanceState) {
             startActivity(intent);
         });
 
+        /*---------------------go to Fragment class--------------------------*/
+        btn_fragment_activity.setOnClickListener(v -> {
+            finish();
+            Intent intent = new Intent(getApplicationContext(), FragmentActivityJava.class);
+            startActivity(intent);
+        });
+
 
         encryptBackup = sharedPreferences.getBoolean(spEncryptBackup, true);
         storageLocation = sharedPreferences.getInt(spStorageLocation, 1);