Skip to content

Latest commit

 

History

History
72 lines (44 loc) · 1.67 KB

README.md

File metadata and controls

72 lines (44 loc) · 1.67 KB
Raw

🦄 Nomen est Omen

Java CI with Gradle

"Your name is your destiny", so be sure you pick a good name. This Java library helps with generating some super-awesome random names that you can use for some unique IDs or passwords :)

Generated names may consist of:

  • adjective (1400+)
  • animals (380+)
  • color name (80+)
  • nouns (850+)
  • person name (140+ names)
  • superb name (10+ names)
  • pokemon name (700+ names)
  • superheroes name (1800+ names)
  • count (any number > 0)

For example, you can get names such: hungry_navy_babbage or dreamy-cray. Isn't this super great?

Usage

It's complicated.

1. Add dependencies

In your Gradle or Maven project, add:

com.oblac:nomen-est-omen:<version>

There are 0 dependencies.

2. Use it

If you just want a short name (adjective and person name):

Nomen.randomName();

If you want to build your own template, e.g.:

Nomen.est().adjective().color().person().get();

Configure it using withXxx() methods:

Nomen.est().adjective().color().person().withSpace('/').get();

That is all.

3. Optimise if you will

Templates can be created once and reused:

Nomen uigen = Nomen.est().adjective().person();
...
String id1 = uigen.get();
String id2 = uigen.get();

Nice!

Thanx to Docker

I am blatantly stealing idea from Docker. It is so beautiful, that it deserves Java port :)

License

BSD