README.md

Arrow

Arrow is Lightweight library toolbox for Java and Android Development. Basically it groups utilites and helper classes commonly used for mobile development. Most of them have been extracted from popular java libraries like Guava or Apache Commons plus other stuff added myself. Refer to the Main Features section for a fully explanation of its capabilities.

Main Features ----------------- - **```Optional```:** An immutable object that may contain a non-null reference to another object. Each instance of this type either contains a non-null reference, or contains nothing (in which case we say that the reference is "absent"); it is never said to "contain null". Refer to Guava ```Optional``` documentation or How to use ```Optional``` on Java and Android.

• Strings: Static utility methods pertaining to String or CharSequence instances. Refer to Guava Strings documentation.

• Preconditions: Static convenience methods that help a method or constructor check whether it was invoked correctly (whether its preconditions have been met). These methods generally accept a boolean expression which is expected to be true (or in the case of checkNotNull, an object reference which is expected to be non-null). When false (or null) is passed instead, the Preconditions method throws an unchecked exception, which helps the calling method communicate to its caller that that caller has made a mistake. Refer to Guava Preconditions documentation.

• Collections: Provides static methods for working with Collection instances. Refer to Guava Collections documentation.

  • FilteredCollection.class
  • Lists.class
  • CollectPreconditions.class
  • Iterables.class
  • Iterators.class
  • MoreArrays.class
  • MoreCollections.class

• MoreObjects: Helper functions that operate on any Object, and are not already provided in Objects. Refer to Guava MoreObjects documentation.

• Annotations: These annotations has no side effect in your code, they are only used for decoration purpose, in case you need either to highlight it or to denotate it.

  • @Beta: Class, method or field is declared as Beta functionality
  • @Experimental: Class, method or field is declared as Experimental
  • @Issue: Class, method or field is linked to an issue. A ref value can be added to specify more information.
  • @See: Class, method or field is linked to a link. A ref value should be added in order to specify the link url.
  • @VisibleForTesting: Class, method or field has its visibility relaxed, so that it is more widely visible than otherwise necessary to make code testable.
  • @WorkInProgress: Class, method or field is declared as work in progress.

Using Arrow ----------------- To enable Arrow, add your dependency in your ```build.gradle``` file:

repositories {
  jcenter()
}

dependencies {
  compile 'com.fernandocejas:arrow:{latest_version}'
}

License -----------------

Copyright 2016 Fernando Cejas

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.