Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Thread safety information to README #128

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add Thread safety information to README #128

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b138a7c
Add Thread safety information to README
kdebski85 Apr 16, 2020
f7cf2a7
Fix spelling in README
kdebski85 Apr 16, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,12 @@ Fairy plFairy = Fairy.create(Locale.forLanguageTag("pl"));
// Polish version
```

## Thread safety

`Fairy` object should not be used concurrently by multiple threads. It is recommended to create `Fairy` instance for each thread.

Some methods are not thread-safe when mutliple threads share the same `Fairy` object. For other methods it is still recommended to create a separate `Fairy` object, because `Random` object utilized underneath does not perform well when used concurrently by multiple threads.

## Other samples

Look into [code samples](https://github.com/Devskiller/jfairy/tree/master/src/test/groovy/snippets/)
Expand Down