HaikunatorJAVA

Generate Heroku-like random names to use in your Java applications

Code Quality Rank: L5

Programming language: Java

License: MIT License

Tags: Utility     String    

README

HaikunatorJAVA

Generate Heroku-like random names to use in your java applications.

Installation

To install Haikunator add the following to your maven configuration

<dependency>
    <groupId>me.atrox.haikunator</groupId>
    <artifactId>Haikunator</artifactId>
    <version>2.0.1</version>
</dependency>

For more examples how to add Haikunator to your project, follow this link

Usage

Haikunator is pretty simple.

import me.atrox.haikunator;

// default usage
Haikunator haikunator = new Haikunator();
haikunator.haikunate() // => "wispy-dust-1337"

// custom length (default=4)
Haikunator haikunator = new Haikunator().setTokenLength(6);
haikunator.haikunate() // => "patient-king-887265"

// use hex instead of numbers
Haikunator haikunator = new Haikunator().setTokenHex(true);
haikunator.haikunate() // => "purple-breeze-98e1"

// use custom chars instead of numbers/hex
Haikunator haikunator = new Haikunator().setTokenChars("HAIKUNATE");
haikunator.haikunate() // => "summer-atom-IHEA"

// don't include a token
Haikunator haikunator = new Haikunator().setTokenLength(0);
haikunator.haikunate() // => "cold-wildflower"

// use a different delimiter
Haikunator haikunator = new Haikunator().setDelimiter(".");
haikunator.haikunate() // => "restless.sea.7976"

// no token, space delimiter
Haikunator haikunator = new Haikunator().setTokenLength(0).setDelimiter(" ");
haikunator.haikunate() // => "delicate haze"

// no token, empty delimiter
Haikunator haikunator = new Haikunator().setTokenLength(0).setDelimiter("");
haikunator.haikunate() // => "billowingleaf"

Options

The following options are available:

Haikunator haikunator = new Haikunator()
                            .setDelimiter("-")
                            .setTokenLength(4)
                            .setTokenHex(false)
                            .setTokenChars("0123456789")
                            .setAdjectives(new String[]{"..."})
                            .setNouns(new String[]{"..."})
                            .setRandom(new Random());

If tokenHex is true, it overrides any tokens specified in tokenChars

Contributing

Everyone is encouraged to help improve this project. Here are a few ways you can help:

• Report bugs
• Fix bugs and submit pull requests
• Write, clarify, or fix documentation
• Suggest or add new features

Other Languages

Haikunator is also available in other languages. Check them out:

• Python: https://github.com/Atrox/haikunatorpy
• Node: https://github.com/Atrox/haikunatorjs
• PHP: https://github.com/Atrox/haikunatorphp
• .NET: https://github.com/Atrox/haikunator.net
• Go: https://github.com/Atrox/haikunatorgo
• Dart: https://github.com/Atrox/haikunatordart
• Ruby: https://github.com/usmanbashir/haikunator
• Rust: https://github.com/nishanths/rust-haikunator