de.flapdoodle.os.common.matcher

Class ImmutableMatchPattern

java.lang.Object

de.flapdoodle.os.common.matcher.ImmutableMatchPattern

All Implemented Interfaces:

Match<String>, MatchPattern

public final class ImmutableMatchPattern
extends Object
implements MatchPattern

Immutable implementation of MatchPattern.

Use the builder to create immutable instances: ImmutableMatchPattern.builder(). Use the static factory method to create immutable instances: ImmutableMatchPattern.of().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImmutableMatchPattern.Builder Builds instances of type ImmutableMatchPattern.

Method Summary

Modifier and Type	Method and Description
static ImmutableMatchPattern.Builder	builder() Creates a builder for ImmutableMatchPattern.
static ImmutableMatchPattern	copyOf(MatchPattern instance) Creates an immutable copy of a MatchPattern value.
boolean	equals(Object another) This instance is equal to all instances of ImmutableMatchPattern that have equal attribute values.
int	hashCode() Computes a hash code from attributes: pattern.
static ImmutableMatchPattern	of(Pattern pattern) Construct a new immutable MatchPattern instance.
Pattern	pattern()
String	toString() Prints the immutable value MatchPattern with attribute values.
ImmutableMatchPattern	withPattern(Pattern value) Copy the current immutable object by setting a value for the pattern attribute.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

pattern

public Pattern pattern()

Specified by:

pattern in interface MatchPattern

Returns:

The value of the pattern attribute

withPattern

public final ImmutableMatchPattern withPattern(Pattern value)

Copy the current immutable object by setting a value for the pattern attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for pattern

Returns:

A modified copy of the this object

equals

public boolean equals(Object another)

This instance is equal to all instances of ImmutableMatchPattern that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: pattern.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value MatchPattern with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static ImmutableMatchPattern of(Pattern pattern)

Construct a new immutable MatchPattern instance.

Parameters:

pattern - The value for the pattern attribute

Returns:

An immutable MatchPattern instance

copyOf

public static ImmutableMatchPattern copyOf(MatchPattern instance)

Creates an immutable copy of a MatchPattern value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.

Parameters:

instance - The instance to copy

Returns:

A copied immutable MatchPattern instance

builder

public static ImmutableMatchPattern.Builder builder()

Creates a builder for ImmutableMatchPattern.

 ImmutableMatchPattern.builder()
    .pattern(regex.Pattern) // required pattern
    .build();
 

Returns:

A new ImmutableMatchPattern builder