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 

Author:

Ahmed Ashour, Ronald Brill, Ween Jiann, cd alexndr, Lai Quang Duong

See Also:

Serialized Form

• Nested Class Summary

  Nested Classes

  Modifier and Type	Class and Description
  static class	URLSearchParams.NativeParamsIterator ES6Iterator implementation for js support.

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

    org.htmlunit.corejs.javascript.ScriptableObject.KeyComparator, org.htmlunit.corejs.javascript.ScriptableObject.LambdaGetterFunction, org.htmlunit.corejs.javascript.ScriptableObject.LambdaSetterFunction

• Field Summary

  Fields

  Modifier and Type	Field and Description
  static 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 and Description
  URLSearchParams () Constructs a new instance.

• Method Summary

  All Methods

  Modifier and Type	Method and 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.
  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.
  org.htmlunit.corejs.javascript.ES6Iterator	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 ()
  org.htmlunit.corejs.javascript.ES6Iterator	keys () The URLSearchParams.keys() method returns an iterator allowing to go through all keys contained in this object.
  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.
  org.htmlunit.corejs.javascript.ES6Iterator	values () The URLSearchParams.values() method returns an iterator allowing to go through all values contained in this object.

  • Methods inherited from class org.htmlunit.javascript.HtmlUnitScriptable

    clone, equivalentValues, get, getBrowserVersion, getClassName, getDomNodeOrDie, getDomNodeOrNull, getPrototype, getScriptableFor, getWindow, getWindow, getWindowFromTopCallScope, 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, checkPropertyChangeForSlot, checkPropertyDefinition, defineBuiltInProperty, defineBuiltInProperty, defineBuiltInProperty, defineBuiltInProperty, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineOwnProperties, defineOwnProperty, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, deleteProperty, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, ensureScriptableObjectButNotSymbol, ensureSymbolScriptable, ensureType, 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, getSuperProperty, getSuperProperty, getSuperProperty, 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, putOwnProperty, putOwnProperty, putOwnProperty, putProperty, putProperty, putProperty, putSuperProperty, putSuperProperty, putSuperProperty, querySlot, redefineProperty, sameValue, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setAttributes, setCommonDescriptorProperties, setExternalArrayData, setGetterOrSetter, setPrototype, size

  • Methods inherited from class org.htmlunit.corejs.javascript.SlotMapOwner

    createSlotMap

  • Methods inherited from class java.lang.Object

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

• Field Detail

  • URL_SEARCH_PARMS_TAG

    public static final String URL_SEARCH_PARMS_TAG

    Constant used to register the prototype in the context.

    See Also:

    Constant Field Values

• Constructor Detail

  • URLSearchParams

    public URLSearchParams()

    Constructs a new instance.

• Method Detail

  • jsConstructor

    public void jsConstructor(Object params)

    Constructs a new instance.

    Parameters:

    params - the params string

  • 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 org.htmlunit.corejs.javascript.ES6Iterator 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 org.htmlunit.corejs.javascript.ES6Iterator 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 org.htmlunit.corejs.javascript.ES6Iterator 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:

    HtmlUnitScriptable.getDefaultValue(java.lang.Class)

  • fillRequest

    public void fillRequest(WebRequest webRequest)

    Sets the specified request with the parameters in this FormData.

    Parameters:

    webRequest - the web request to fill