package io.ebean.typequery;

String property.
Type parameters:
<R> – the root query bean type/**
 * String property.
 *
 * @param <R> the root query bean type
 */
public class PString<R> extends PBaseCompareable<R, String> {

  
Construct with a property name and root instance.
Params:
name – property name
root – the root query bean instance/**
   * Construct with a property name and root instance.
   *
   * @param name property name
   * @param root the root query bean instance
   */
  public PString(String name, R root) {
    super(name, root);
  }

  
Construct with additional path prefix.
/**
   * Construct with additional path prefix.
   */
  public PString(String name, R root, String prefix) {
    super(name, root, prefix);
  }

  
Case insensitive is equal to.
Params:
value – the equal to bind value
Returns:
the root query bean instance/**
   * Case insensitive is equal to.
   *
   * @param value the equal to bind value
   * @return the root query bean instance
   */
  public R ieq(String value) {
    expr().ieq(_name, value);
    return _root;
  }

  
Case insensitive is equal to.
Params:
value – the equal to bind value
Returns:
the root query bean instance/**
   * Case insensitive is equal to.
   *
   * @param value the equal to bind value
   * @return the root query bean instance
   */
  public R iequalTo(String value) {
    expr().ieq(_name, value);
    return _root;
  }

  
Like - include '%' and '_' placeholders as necessary.
Params:
value – the equal to bind value
Returns:
the root query bean instance/**
   * Like - include '%' and '_' placeholders as necessary.
   *
   * @param value the equal to bind value
   * @return the root query bean instance
   */
  public R like(String value) {
    expr().like(_name, value);
    return _root;
  }

  
Starts with - uses a like with '%' wildcard added to the end.
Params:
value – the equal to bind value
Returns:
the root query bean instance/**
   * Starts with - uses a like with '%' wildcard added to the end.
   *
   * @param value the equal to bind value
   * @return the root query bean instance
   */
  public R startsWith(String value) {
    expr().startsWith(_name, value);
    return _root;
  }

  
Ends with - uses a like with '%' wildcard added to the beginning.
Params:
value – the equal to bind value
Returns:
the root query bean instance/**
   * Ends with - uses a like with '%' wildcard added to the beginning.
   *
   * @param value the equal to bind value
   * @return the root query bean instance
   */
  public R endsWith(String value) {
    expr().endsWith(_name, value);
    return _root;
  }

  
Contains - uses a like with '%' wildcard added to the beginning and end.
Params:
value – the equal to bind value
Returns:
the root query bean instance/**
   * Contains - uses a like with '%' wildcard added to the beginning and end.
   *
   * @param value the equal to bind value
   * @return the root query bean instance
   */
  public R contains(String value) {
    expr().contains(_name, value);
    return _root;
  }

  
Case insensitive like.
Params:
value – the equal to bind value
Returns:
the root query bean instance/**
   * Case insensitive like.
   *
   * @param value the equal to bind value
   * @return the root query bean instance
   */
  public R ilike(String value) {
    expr().ilike(_name, value);
    return _root;
  }

  
Case insensitive starts with.
Params:
value – the equal to bind value
Returns:
the root query bean instance/**
   * Case insensitive starts with.
   *
   * @param value the equal to bind value
   * @return the root query bean instance
   */
  public R istartsWith(String value) {
    expr().istartsWith(_name, value);
    return _root;
  }

  
Case insensitive ends with.
Params:
value – the equal to bind value
Returns:
the root query bean instance/**
   * Case insensitive ends with.
   *
   * @param value the equal to bind value
   * @return the root query bean instance
   */
  public R iendsWith(String value) {
    expr().iendsWith(_name, value);
    return _root;
  }

  
Case insensitive contains.
Params:
value – the equal to bind value
Returns:
the root query bean instance/**
   * Case insensitive contains.
   *
   * @param value the equal to bind value
   * @return the root query bean instance
   */
  public R icontains(String value) {
    expr().icontains(_name, value);
    return _root;
  }

  
Add a full text "Match" expression.

This means the query will automatically execute against the document store (ElasticSearch).

Params:
value – the match expression/**
   * Add a full text "Match" expression.
   * <p>
   * This means the query will automatically execute against the document store (ElasticSearch).
   * </p>
   *
   * @param value the match expression
   */
  public R match(String value) {
    expr().match(_name, value);
    return _root;
  }
}