val arr = arrayOf("test", "array")

//Ex 1: try code, no return
try {
    val elm = arr[5]
    exampleFun(elm)
} catch (e: Exception) {
    Log.d("Tag", e.message, e)
}

//Ex 2: set from array or null
val arrValueOrNull: String? =
    try {
        arr[5]
    } catch (e: Exception) {
        Log.d("Tag", e.message, e)
        null
    }

//Ex 3: set from array or "fail"
val arrValueOrDefault: String =
    try {
        arr[3]
    } catch (e: Exception) {
        Log.d("Tag", e.message, e)
        "fail"
    }

val arr = arrayOf("test", "array")

//Optional, set once, catchAction empty by default
Try.GlobalConfig.catchAction = {
    Log.d("Tag", it.message, it)
}

//Ex 1: try code, no return
Try.me {
    val elm = arr[5]
    exampleFun(elm)
}

//Ex 2: set from array or null
val arrValueOrNull: String? =
    Try.me {
        arr[5]
    }

//Ex 3: set from array or "fail"
val arrValueOrDefault: String =
    Try.me(defaultReturnValue = "fail") {
        arr[5]
    }

• No setup code required before using TryMe. Just call the static Try.me() function with your block of code and TryMe handles the rest!
  • Optionally, a defaultReturnValue argument can be included where that value is returned only if an exception is caught.
• Rather than a mandatory catch block, optionally and just once, create a global catch block (see GlobalConfig) that will only be called when TryMe throws an exception anywhere in your app!
• No code compromise using TryMe over the standard try. The same code that can handled in a try can be handled in TryMe!
  
  

• Examples
• Syntax
• Installation
• Versioning
• License
  
  

The following tries to take a value from the String array, arr, and pass it to a function. If an ArrayIndexOutOfBoundsException is thrown, exampleFun() is not called, Try.GlobalConfig.catchAction is called, then the program continues without crashing.

Try.me {
    val elm = arr[5]
    exampleFun(elm)
}

The following tries to take a value from the String array, arr, to return it and set arrValueOrNull with that value. Since defaultReturnValue was not passed into TryMe, if an ArrayIndexOutOfBoundsException is thrown, Try.GlobalConfig.catchAction is called first, then null will be returned from TryMe setting arrValueOrNull.

val arrValueOrNull: String? =
    Try.me {
        arr[5]
    }

The following tries to take a value from the String array, arr, to return it and set arrValueOrDefault with that value. Because a non-null defaultReturnValue was passed in, the set type for arrValueOrDefault is never null. If an ArrayIndexOutOfBoundsException is thrown, Try.GlobalConfig.catchAction is called first, then the passed value "failed" will be returned from TryMe setting arrValueOrDefault.

val arrValueOrDefault: String =
    Try.me(defaultReturnValue = "failed") {
        arr[5]
    }

Usage is simply calling the static Try.me() function passing your block of code (and optionally a default return value):

• defaultReturnValue - T / Optional (Defaults to inferred type passed in. T? if undefined)
  • When an exception is caught calling Try.me, Try.GlobalConfig.catchAction is always called first, then the passed defaultReturnValue will be returned. When undefined, null is returned which also changes the TryMe return type to nullable.
• attempt - () -> T / Required
  • The block of code you wish to have TryMe run and handle exceptions caught. Same code can be used here as would in a standard try.

See Examples section for code using these arguments.

Try.GlobalConfig has all the public configurable settings (currently just one) that can be updated anytime during runtime. If any are intended to be updated, it is recommended to do so as early as possible (like in your main activity's OnCreate()).

The following are the settings set to their default values.

• /**
   * Only called when Try.me throws an exception (allowing for the same redundant code to be called everywhere Try.me is used).
   * By default does nothing.
   * Reassigning Example: Try.GlobalConfig.catchAction = { Log.d("TryMeCaught", it.message, it) }
   */
  Try.GlobalConfig.catchAction = {}

1. Download the latest tryme.aar.
2. Move tryme.aar to your project's libs directory (Example: YourProject/app/libs/).
3. In your build.gradle, add only one of the following to your dependencies { }:

• // adds only tryme.aar
  implementation fileTree(dir: "libs", include: ["tryme.aar"])
  
  // OR
  
  // adds all .aar files in your libs directory.
  implementation fileTree(dir: "libs", include: ["*.aar"]) 

4. Sync gradle successfully.
5. Done! Your Android project is now ready to use Try Me. Go to Examples or Syntax for Try Me usage!

Coming soon!

• SemVer is used for versioning.
• Given a version number MAJOR . MINOR . PATCH
  1. MAJOR version - Incompatible API changes.
  2. MINOR version - Functionality added in a backwards-compatible manner.
  3. PATCH version - Backwards-compatible bug fixes.
     
     

Try Me created by Adam Steinberg of DIGIDEMIC, LLC

Copyright 2023 DIGIDEMIC, LLC

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.