readable-regex

This library provides a way to make complex regular expressions in Java code more readable.

License	MIT License
Categories	Net
GroupId	net.codebox
ArtifactId	readable-regex
Last Version	1.0.0
Release Date	Aug 11, 2017
Type	jar
Description	readable-regex This library provides a way to make complex regular expressions in Java code more readable.
Project URL	https://github.com/codebox/readable-regex
Source Code Management	https://github.com/codebox/readable-regex

Download readable-regex

Filename	Size
readable-regex-1.0.0.pom
readable-regex-1.0.0.jar	9 KB
readable-regex-1.0.0-sources.jar	6 KB
readable-regex-1.0.0-javadoc.jar	35 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/net.codebox/readable-regex/ -->
<dependency>
    <groupId>net.codebox</groupId>
    <artifactId>readable-regex</artifactId>
    <version>1.0.0</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/net.codebox/readable-regex/
implementation 'net.codebox:readable-regex:1.0.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/net.codebox/readable-regex/
implementation ("net.codebox:readable-regex:1.0.0")

Apache Buildr

'net.codebox:readable-regex:jar:1.0.0'

Apache Ivy

<dependency org="net.codebox" name="readable-regex" rev="1.0.0">
  <artifact name="readable-regex" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='net.codebox', module='readable-regex', version='1.0.0')
)

Scala SBT

libraryDependencies += "net.codebox" % "readable-regex" % "1.0.0"

Leiningen

[net.codebox/readable-regex "1.0.0"]

Dependencies

compile (1)

Group / Artifact	Type	Version
junit : junit	jar	4.11

test (1)

Group / Artifact	Type	Version
org.hamcrest : hamcrest-all	jar	1.3

Project Modules

There are no modules declared in this project.

Readable Regex

This library provides a way to make complex regular expressions in Java code more readable.

The best way to explain what it does to show some examples:

 // Matches a single digit
    RegExBuilder.build(anyDigit()); // "[0-9]"

 // Matches exactly 2 digits
    RegExBuilder.build(exactly(2).of(anyDigit())); // "[0-9]{2}"

 // Matches between 2 and 4 letters
    RegExBuilder.build(between(2,4).of(anyLetter())); // "[a-zA-Z]{2,4}"

Characters that have special meaning within a regular expression are escaped automatically:

 // Matches one or more occurrences of the text 'Ho?'
    RegExBuilder.build(oneOrMore().of("Ho?")); // "(Ho\?)+"
    
 // Matches anything except an opening or closing square bracket, or a backslash
    RegExBuilder.build(
        anyCharacterExcept(
            characters('[', ']','\\')
        )
    ); // "[^[\\]\\\\]"

Readability is greatly improved for more complex expressions:

 // More or less validates the format of an email address
 // [_\\-A-Za-z0-9]+(\\.[_\\-A-Za-z0-9]+)*@[A-Za-z0-9]+(\\.[A-Za-z0-9]+)*\\.[a-zA-Z]{2,}
    RegExBuilder.build(
        oneOrMore().of(
            anyOneOf(
                characters('_','-'), range('A','Z'), range('a','z'), range('0','9')
            )
        ),
        zeroOrMore().of(
            text("."),
            oneOrMore().of(
                anyOneOf(
                    characters('_','-'), range('A','Z'), range('a','z'), range('0','9')
                )
            )
        ),
        text("@"),
        oneOrMore().of(
            anyOneOf(
                range('A','Z'), range('a','z'), range('0','9')
            )
        ),
        zeroOrMore().of(
            text("."),
            oneOrMore().of(
                anyOneOf(
                    range('A','Z'), range('a','z'), range('0','9')
                )
            )
        ),
        text("."),
        atLeast(2).of(
            anyLetter()
        )
    );

All classes in the library are immutable, and therefore instances are re-usable and thread-safe.

Versions

Version
1.0.0 Aug 11, 2017