Class URLSearchParams

java.lang.Object
org.htmlunit.corejs.javascript.ScriptableObject
org.htmlunit.javascript.HtmlUnitScriptable
org.htmlunit.javascript.host.URLSearchParams
All Implemented Interfaces:
Serializable, Cloneable, org.htmlunit.corejs.javascript.ConstProperties, org.htmlunit.corejs.javascript.debug.DebuggableObject, org.htmlunit.corejs.javascript.Scriptable, org.htmlunit.corejs.javascript.SymbolScriptable
public class URLSearchParams extends HtmlUnitScriptable
A JavaScript object for URLSearchParams.
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    URLSearchParams.NativeParamsIterator
     

    Nested classes/interfaces inherited from class org.htmlunit.corejs.javascript.ScriptableObject

    org.htmlunit.corejs.javascript.ScriptableObject.KeyComparator

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private static final org.apache.commons.logging.Log
    LOG
     
    private URL
    url_
     
    static final String
    URL_SEARCH_PARMS_TAG
    Constant used to register the prototype in the context.

    Fields inherited from class org.htmlunit.corejs.javascript.ScriptableObject

    CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

    Fields inherited from interface org.htmlunit.corejs.javascript.Scriptable

    NOT_FOUND

  • Constructor Summary

    Constructors
    Constructor
    Description
    URLSearchParams()
    Constructs a new instance.
    URLSearchParams(URL url)
    Constructs a new instance for the given js url.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    append(String name, String value)
    The append() method of the URLSearchParams interface appends a specified key/value pair as a new search parameter.
    private static org.htmlunit.corejs.javascript.IteratorLikeIterable
    buildIteratorLikeIterable(org.htmlunit.corejs.javascript.Context cx, org.htmlunit.corejs.javascript.Scriptable iterable)
     
    void
    delete(String name)
    The delete() method of the URLSearchParams interface deletes the given search parameter and its associated value, from the list of all search parameters.
    Object
    entries()
    The URLSearchParams.entries() method returns an iterator allowing to go through all key/value pairs contained in this object.
    void
    fillRequest(WebRequest webRequest)
    Sets the specified request with the parameters in this FormData.
    void
    forEach(Object callback)
    The URLSearchParams.forEach() method allows iteration through all key/value pairs contained in this object via a callback function.
    String
    get(String name)
    The get() method of the URLSearchParams interface returns the first value associated to the given search parameter.
    org.htmlunit.corejs.javascript.Scriptable
    getAll(String name)
    The getAll() method of the URLSearchParams interface returns all the values associated with a given search parameter as an array.
    Object
    getDefaultValue(Class<?> hint)
    Calls for instance for implicit conversion to string.
    int
    getSize()
     
    boolean
    has(String name)
    The has() method of the URLSearchParams interface returns a Boolean that indicates whether a parameter with the specified name exists.
    void
    jsConstructor(Object params)
    Constructs a new instance.
    String
    jsToString()
     
    Object
    keys()
    The URLSearchParams.keys() method returns an iterator allowing to go through all keys contained in this object.
    private static List<NameValuePair>
    resolveParams(Object params)
     
    void
    set(String name, String value)
    The set() method of the URLSearchParams interface sets the value associated with a given search parameter to the given value.
    private List<NameValuePair>
    splitQuery()
     
    private static List<NameValuePair>
    splitQuery(String params)
     
    private static NameValuePair
    splitQueryParameter(String singleParam)
     
    Object
    values()
    The URLSearchParams.values() method returns an iterator allowing to go through all values contained in this object.

    Methods inherited from class HtmlUnitScriptable

    clone, equivalentValues, get, getBrowserVersion, getClassName, getDomNodeOrDie, getDomNodeOrNull, getPrototype, getScriptableFor, getStartingScope, getWindow, getWindow, getWithPreemption, has, hasInstance, initParentScope, makeScriptableFor, put, setClassName, setDomNode, setDomNode, setParentScope, setupPromise, setupRejectedPromise

    Methods inherited from class org.htmlunit.corejs.javascript.ScriptableObject

    applyDescriptorToAttributeBitset, associateValue, avoidObjectDetection, buildDataDescriptor, callMethod, callMethod, checkPropertyChange, checkPropertyDefinition, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineOwnProperties, defineOwnProperty, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, deleteProperty, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, ensureSymbolScriptable, get, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGeneratorFunctionPrototype, getGetterOrSetter, getGetterOrSetter, getIds, getObjectPrototype, getOwnPropertyDescriptor, getParentScope, getProperty, getProperty, getProperty, getPropertyIds, getPrototype, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, has, hasProperty, hasProperty, hasProperty, isAccessorDescriptor, isConst, isDataDescriptor, isEmpty, isExtensible, isFalse, isGenericDescriptor, isGetterOrSetter, isSealed, isTrue, preventExtensions, put, put, putConst, putConstProperty, putProperty, putProperty, putProperty, querySlot, redefineProperty, sameValue, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setAttributes, setCommonDescriptorProperties, setExternalArrayData, setGetterOrSetter, setPrototype, size

    Methods inherited from class Object

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

  • Field Details

    • LOG

      private static final org.apache.commons.logging.Log LOG

    • URL_SEARCH_PARMS_TAG

      public static final String URL_SEARCH_PARMS_TAG
      Constant used to register the prototype in the context.
      See Also:

    • url_

      private URL url_

  • Constructor Details

    • URLSearchParams

      public URLSearchParams()
      Constructs a new instance.

    • URLSearchParams

      URLSearchParams(URL url)
      Constructs a new instance for the given js url.
      Parameters:
      url - the base url

  • Method Details

    • jsConstructor

      public void jsConstructor(Object params)
      Constructs a new instance.
      Parameters:
      params - the params string

    • resolveParams

      private static List<NameValuePair> resolveParams(Object params)

    • splitQuery

      private List<NameValuePair> splitQuery()

    • splitQuery

      private static List<NameValuePair> splitQuery(String params)

    • splitQueryParameter

      private static NameValuePair splitQueryParameter(String singleParam)

    • buildIteratorLikeIterable

      private static org.htmlunit.corejs.javascript.IteratorLikeIterable buildIteratorLikeIterable(org.htmlunit.corejs.javascript.Context cx, org.htmlunit.corejs.javascript.Scriptable iterable)

    • append

      public void append(String name, String value)
      The append() method of the URLSearchParams interface appends a specified key/value pair as a new search parameter.
      Parameters:
      name - The name of the parameter to append.
      value - The value of the parameter to append.

    • delete

      public void delete(String name)
      The delete() method of the URLSearchParams interface deletes the given search parameter and its associated value, from the list of all search parameters.
      Specified by:
      delete in interface org.htmlunit.corejs.javascript.Scriptable
      Overrides:
      delete in class org.htmlunit.corejs.javascript.ScriptableObject
      Parameters:
      name - The name of the parameter to be deleted.

    • get

      public String get(String name)
      The get() method of the URLSearchParams interface returns the first value associated to the given search parameter.
      Parameters:
      name - The name of the parameter to return.
      Returns:
      An array of USVStrings.

    • getAll

      public org.htmlunit.corejs.javascript.Scriptable getAll(String name)
      The getAll() method of the URLSearchParams interface returns all the values associated with a given search parameter as an array.
      Parameters:
      name - The name of the parameter to return.
      Returns:
      An array of USVStrings.

    • set

      public void set(String name, String value)
      The set() method of the URLSearchParams interface sets the value associated with a given search parameter to the given value. If there were several matching values, this method deletes the others. If the search parameter doesn't exist, this method creates it.
      Parameters:
      name - The name of the parameter to set.
      value - The value of the parameter to set.

    • has

      public boolean has(String name)
      The has() method of the URLSearchParams interface returns a Boolean that indicates whether a parameter with the specified name exists.
      Parameters:
      name - The name of the parameter to find.
      Returns:
      A Boolean.

    • forEach

      public void forEach(Object callback)
      The URLSearchParams.forEach() method allows iteration through all key/value pairs contained in this object via a callback function.
      Parameters:
      callback - Function to execute on each key/value pairs

    • entries

      public Object entries()
      The URLSearchParams.entries() method returns an iterator allowing to go through all key/value pairs contained in this object. The key and value of each pair are USVString objects.
      Returns:
      an iterator.

    • keys

      public Object keys()
      The URLSearchParams.keys() method returns an iterator allowing to go through all keys contained in this object. The keys are USVString objects.
      Returns:
      an iterator.

    • values

      public Object values()
      The URLSearchParams.values() method returns an iterator allowing to go through all values contained in this object. The values are USVString objects.
      Returns:
      an iterator.

    • getSize

      public int getSize()
      Returns:
      the total number of search parameter entries

    • jsToString

      public String jsToString()
      Returns:
      the text of the URLSearchParams

    • getDefaultValue

      public Object getDefaultValue(Class<?> hint)
      Calls for instance for implicit conversion to string.
      Specified by:
      getDefaultValue in interface org.htmlunit.corejs.javascript.Scriptable
      Overrides:
      getDefaultValue in class HtmlUnitScriptable
      Parameters:
      hint - the type hint
      Returns:
      the default value
      See Also:

    • fillRequest

      public void fillRequest(WebRequest webRequest)
      Sets the specified request with the parameters in this FormData.
      Parameters:
      webRequest - the web request to fill