org.takes.facets.fork

Class FkRegex

java.lang.Object

org.takes.facets.fork.FkRegex

All Implemented Interfaces:

Fork<Take>, Fork.AtTake

public final class FkRegex
extends Object
implements Fork.AtTake

Fork by regular expression pattern.

Use this class in combination with TsFork, for example:

 Takes takes = new TsFork(
   new FkRegex("/home", new TsHome()),
   new FkRegex("/account", new TsAccount())
 );

Each instance of FkRegex is being asked only once by TsFork whether the request is good enough to be processed. If the request is suitable for this particular fork, it will return the relevant Take.

Also, keep in mind that the second argument of the constructor may be of type Target and accept an instance of RqRegex, which makes it very convenient to reuse regular expression matcher, for example:

 Takes takes = new TsFork(
   new FkRegex(
     "/file(.*)",
     new Target<RqRegex>() {
       @Override
       public Take route(final RqRegex req) {
         // Here we immediately getting access to the
         // matcher that was used during parsing of
         // the incoming request
         final String file = req.matcher().group(1);
       }
     }
   )
 );

The class is immutable and thread-safe.

Since:

0.4

Version:

$Id$

Author:

Yegor Bugayenko ([email protected])

See Also:

TsFork, Target

Nested Class Summary

Nested classes/interfaces inherited from interface org.takes.facets.fork.Fork

Fork.AtResponse, Fork.AtTake

Constructor Summary

Constructors

Constructor and Description
FkRegex(Pattern ptn, Takes tks) Ctor.
FkRegex(Pattern ptn, Target<RqRegex> tgt) Ctor.
FkRegex(String ptn, String text) Ctor.
FkRegex(String ptn, Take take) Ctor.
FkRegex(String ptn, Takes tks) Ctor.
FkRegex(String ptn, Target<RqRegex> tgt) Ctor.

Method Summary

Methods

Modifier and Type	Method and Description
Iterator<Take>	route(Request req) Process this request or ignore it.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FkRegex

public FkRegex(String ptn,
       String text)

Ctor.

Parameters:

ptn - Pattern

text - Text

FkRegex

public FkRegex(String ptn,
       Take take)

Ctor.

Parameters:

ptn - Pattern

take - Take

FkRegex

public FkRegex(String ptn,
       Takes tks)

Ctor.

Parameters:

ptn - Pattern

tks - Takes

FkRegex

public FkRegex(Pattern ptn,
       Takes tks)

Ctor.

Parameters:

ptn - Pattern

tks - Takes

FkRegex

public FkRegex(String ptn,
       Target<RqRegex> tgt)

Ctor.

Parameters:

ptn - Pattern

tgt - Takes

FkRegex

public FkRegex(Pattern ptn,
       Target<RqRegex> tgt)

Ctor.

Parameters:

ptn - Pattern

tgt - Takes

Method Detail

route

public Iterator<Take> route(Request req)
                     throws IOException

Description copied from interface: Fork

Process this request or ignore it.

Specified by:

route in interface Fork<Take>

Parameters:

req - Request

Returns:

Non-empty list of takes if it was processed

Throws:

IOException - If fails