Package ai.attackframework.tools.burp.utils.text

Record Class TextQuery

java.lang.Object
java.lang.Record
ai.attackframework.tools.burp.utils.text.TextQuery
public record TextQuery(String query, boolean caseSensitive, boolean regex, boolean multiline) extends Record
Immutable description of a user text query used by validation and search code.

This record intentionally contains only the minimum state required to derive regex flags and substring behavior. It has no Swing dependencies and can be used by any module.

  • Constructor Summary

    Constructors
    Constructor
    Description
    TextQuery(String query, boolean caseSensitive, boolean regex, boolean multiline)
    Creates an instance of a TextQuery record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    caseSensitive()
    Returns the value of the caseSensitive record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    isBlank()
    Indicates whether the query string is null/blank and therefore not actionable.
    boolean
    multiline()
    Returns the value of the multiline record component.
    String
    query()
    Returns the value of the query record component.
    boolean
    regex()
    Returns the value of the regex record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • TextQuery

      public TextQuery(String query, boolean caseSensitive, boolean regex, boolean multiline)
      Creates an instance of a TextQuery record class.
      Parameters:
      query - the value for the query record component
      caseSensitive - the value for the caseSensitive record component
      regex - the value for the regex record component
      multiline - the value for the multiline record component

  • Method Details

    • isBlank

      public boolean isBlank()
      Indicates whether the query string is null/blank and therefore not actionable. Callers should short-circuit search/validation when this returns true.
      Returns:
      true if the query is null or blank

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • query

      public String query()
      Returns the value of the query record component.
      Returns:
      the value of the query record component

    • caseSensitive

      public boolean caseSensitive()
      Returns the value of the caseSensitive record component.
      Returns:
      the value of the caseSensitive record component

    • regex

      public boolean regex()
      Returns the value of the regex record component.
      Returns:
      the value of the regex record component

    • multiline

      public boolean multiline()
      Returns the value of the multiline record component.
      Returns:
      the value of the multiline record component