Package org.apache.tinkerpop.gremlin.process.traversal

Class TextP

java.lang.Object

org.apache.tinkerpop.gremlin.process.traversal.P<String>

org.apache.tinkerpop.gremlin.process.traversal.TextP

All Implemented Interfaces:

Serializable, Cloneable, Predicate<String>

public class TextP
extends P<String>

Predefined Predicate values that can be used as String filters.

Author:

Daniel Kuppitz (http://gremlin.guru)

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.tinkerpop.gremlin.process.traversal.P

biPredicate, originalValue, value

Constructor Summary

Constructors

Constructor	Description
TextP(BiPredicate<String,String> biPredicate, String value)

Method Summary

Modifier and Type	Method	Description
TextP	clone()
static TextP	containing(String value)	Determines if String does contain the given value.
static TextP	endingWith(String value)	Determines if String does start with the given value.
boolean	equals(Object other)
TextP	negate()
static TextP	notContaining(String value)	Determines if String does not contain the given value.
static TextP	notEndingWith(String value)	Determines if String does not start with the given value.
static TextP	notRegex(String value)	Determines if String has no match with the given regex pattern and the reference implementation treats it as a simple negation of the evaluation of the pattern match of regex(String).
static TextP	notStartingWith(String value)	Determines if String does not start with the given value.
static TextP	regex(String value)	Determines if String has a match with the given regex pattern.
static TextP	startingWith(String value)	Determines if String does start with the given value.
String	toString()

Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.P

and, between, eq, getBiPredicate, getOriginalValue, getValue, gt, gte, hashCode, inside, lt, lte, neq, not, or, outside, setValue, test, test, within, within, without, without

Methods inherited from class java.lang.Object

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

Constructor Detail

TextP

public TextP(BiPredicate<String,String> biPredicate,
             String value)

Method Detail

equals

public boolean equals(Object other)

Overrides:

equals in class P<String>

toString

public String toString()

Overrides:

toString in class P<String>

negate

public TextP negate()

Specified by:

negate in interface Predicate<String>

Overrides:

negate in class P<String>

clone

public TextP clone()

Overrides:

clone in class P<String>

startingWith

public static TextP startingWith(String value)

Determines if String does start with the given value.

Since:

3.4.0

notStartingWith

public static TextP notStartingWith(String value)

Determines if String does not start with the given value.

Since:

3.4.0

endingWith

public static TextP endingWith(String value)

Determines if String does start with the given value.

Since:

3.4.0

notEndingWith

public static TextP notEndingWith(String value)

Determines if String does not start with the given value.

Since:

3.4.0

containing

public static TextP containing(String value)

Determines if String does contain the given value.

Since:

3.4.0

notContaining

public static TextP notContaining(String value)

Determines if String does not contain the given value.

Since:

3.4.0

regex

public static TextP regex(String value)

Determines if String has a match with the given regex pattern. The TinkerPop reference implementation uses Java syntax for regex. The string is considered a match to the pattern if any substring matches the pattern. It is therefore important to use the appropriate boundary matchers (e.g. `$` for end of a line) to ensure a proper match.

Since:

3.6.0

notRegex

public static TextP notRegex(String value)

Determines if String has no match with the given regex pattern and the reference implementation treats it as a simple negation of the evaluation of the pattern match of regex(String).

Since:

3.6.0