Skip to content

Commit

Permalink
Updated README and added a change log
Browse files Browse the repository at this point in the history
  • Loading branch information
dmstocking committed Jan 23, 2017
1 parent d604032 commit 39b619c
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 3 deletions.
15 changes: 15 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Change Log
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).

## [1.1] - 2017-01-22
- Optional
- Added ifPresentOrElse
- Added or
- Added OptionalInt
- Added OptionalLong
- Added OptionalDouble

[1.1]: https://github.com/olivierlacan/keep-a-changelog/compare/1.0...1.1
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
support-optional
===============================================

support-optional provides a Java 8 optional that supports Java 6, Android and
support-optional provides a Java 9 optional that supports Java 6, Android and
RetroLambda development while having an easy migration to the real optional
class. This library is much in the spirit of ActionBarSherlock that it was only
designed to be a removed.
Expand All @@ -15,7 +15,7 @@ day throw it away. <br>
Other backports have various problems like different class names, slightly
different behavior or interface default methods. These make it harder to use and
migrate to the real Java 8 optional class. So here is yet another optional
migrate to the real Java 9 optional class. So here is yet another optional
backport, so you don't have to waste your time writing one.

Download
Expand All @@ -31,7 +31,7 @@ repositories {
Then add the following to your modules build.gradle file
```gradle
dependencies {
compile 'com.github.dmstocking:support-optional:1.0'
compile 'com.github.dmstocking:support-optional:1.1'
}
```

Expand All @@ -53,6 +53,18 @@ find . -name "*.java" -exec sed -i 's/com\.github\.dmstocking\.optional\.//g' {}
or with an IDE so a search and replace without regex of
`com.github.dmstocking.optional.` with nothing over your entire src directory.

Unavailable Methods
-------------------

```
- Optional<T>::stream()
- OptionalInt::stream()
- OptionalLong::stream()
- OptionalDouble::stream()
```
Because this library does not backport streams, there is no stream method on any of the Optional
classes.

License
-------

Expand Down

0 comments on commit 39b619c

Please sign in to comment.