UrlQueryFilter

java.lang.Object
- ohos.utils.net.UrlQueryFilter

public class UrlQueryFilter
extends Object

Provides basic URL query analysis capabilities, including filtering invalid characters and obtaining query parameter pairs.

A simple example is as follows:

 UrlQueryFilter urlFilter = new UrlQueryFilter();
 String url = "http://www.xxx:port/xxxx/xxxx?name=tom&name=lily&age=20";
 urlFilter.parseUrl(url);

从以下版本开始:: 4

嵌套类概要

嵌套类
限定符和类型	类	说明
`static class`	`UrlQueryFilter.ValueFilter`	Represents a filter used to filter out invalid characters in a query string and replace them with spaces or underscores (_).

构造器概要

构造器
构造器说明

UrlQueryFilter()
A constructor used to create a UrlQueryFilter instance.

构造器
构造器	说明
`UrlQueryFilter()`	A constructor used to create a `UrlQueryFilter` instance.

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法	说明
`protected void`	`addParams(Pair<String,String> entry)`	Adds a filtered parameter key-value pair to the internal `List` and `Map` objects.
`void`	`allowUnregisteredParameters(boolean allow)`	Sets whether to allow query of unregistered parameters.
`boolean`	`containParameter(String paramName)`	Checks whether a query parameter pair exists based on the specified key.
`static UrlQueryFilter.ValueFilter`	`filterEncodedUrl()`	Obtains a `ValueFilter` that allows all possible characters in an encoded URL.
`static UrlQueryFilter.ValueFilter`	`filterNulWithSpace()`	Obtains a `ValueFilter` object that can replace `/0` with a space.
`boolean`	`getFirstPriority()`	Checks whether the value matching the first one of duplicate keys in the parameter pair has the top priority.
`UrlQueryFilter.ValueFilter`	`getParameterFilter(String name)`	Obtains the `ValueFilter` of a specified parameter key.
`List<Pair<String,String>>`	`getParamsListFiltered()`	Obtains the `List<Pair<String,String>>` value of all query parameters in the sequence they appear in the URL.
`Set<String>`	`getParamsSetFiltered()`	Obtains the `Set<String>` object that contains the keys of all query parameters.
`String`	`getParamValue(String paramName)`	Obtains the value matching a specified key in the URL query parameter.
`UrlQueryFilter.ValueFilter`	`getUnregisteredParamFilter()`	Obtains the `ValueFilter` that is used to filter out unregistered parameters.
`boolean`	`isAllowUnregisteredParameters()`	Checks whether to allow query of unregistered parameters.
`protected void`	`parseParamPair(String name, String value)`	Parses an escaped query parameter pair.
`void`	`parseUrl(String url)`	Parses a specified URL.
`void`	`parseUrlQuery(String query)`	Parses the specified query string of a URL.
`void`	`registerParameterFilter(String name, UrlQueryFilter.ValueFilter filter)`	Specifies a `ValueFilter` for a parameter key to filter out invalid characters of the value for this key.
`void`	`setFirstPriority(boolean value)`	Sets the value priority for duplicate keys in a query parameter pair.
`void`	`setUnregisteredParamFilter(UrlQueryFilter.ValueFilter filter)`	Sets a `ValueFilter` for unregistered parameter keys.
`String`	`unescapeString(String str)`	Unescapes a specified string.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - UrlQueryFilter
```
public UrlQueryFilter()
```
    A constructor used to create a UrlQueryFilter instance.
    
    从以下版本开始:
    
    4
- 方法详细资料
  - filterNulWithSpace
```
public static final UrlQueryFilter.ValueFilter filterNulWithSpace()
```
    Obtains a ValueFilter object that can replace /0 with a space.
    
    返回:
    
    Returns the obtained ValueFilter object.
    
    从以下版本开始:
    
    4
  - filterEncodedUrl
```
public static final UrlQueryFilter.ValueFilter filterEncodedUrl()
```
    Obtains a ValueFilter that allows all possible characters in an encoded URL.
    This method is not supported by script URLs.
    
    返回:
    
    Returns the ValueFilter.
    
    从以下版本开始:
    
    5
  - getParamsListFiltered
```
public List<Pair<String,String>> getParamsListFiltered()
```
    Obtains the List<Pair<String,String>> value of all query parameters in the sequence they appear in the URL.
    You should call this method after the parseUrl(java.lang.String) method is executed.
    
    返回:
    
    Returns a List<Pair<String, String>> object, which contains all URL query parameter pairs after filtering.
    
    从以下版本开始:
    
    4
  - getParamsSetFiltered
```
public Set<String> getParamsSetFiltered()
```
    Obtains the Set<String> object that contains the keys of all query parameters.
    You should call this method after the parseUrl(java.lang.String) method is executed. The Set<String> object does not contain duplicate keys.
    
    返回:
    
    Returns a Set<String> object that contains the keys of all query parameters.
    
    从以下版本开始:
    
    4
  - setFirstPriority
```
public void setFirstPriority(boolean value)
```
    Sets the value priority for duplicate keys in a query parameter pair.
    If value is set to true, the value matching the first key has the top priority. If value is false (default setting), the value matching the last key has the top priority.
    
    参数:
    
    value - Specifies whether the value matching the first key has the top priority if there are duplicate keys in the parameter pair.
    
    从以下版本开始:
    
    4
  - getFirstPriority
```
public boolean getFirstPriority()
```
    Checks whether the value matching the first one of duplicate keys in the parameter pair has the top priority.
    
    返回:
    
    Returns true if the value of the first key has the top priority; returns false otherwise.
    
    从以下版本开始:
    
    4
  - getParamValue
```
public String getParamValue(String paramName)
```
    Obtains the value matching a specified key in the URL query parameter.
    If the key does not exist, null is returned.
    
    参数:
    
    paramName - Indicates the key to match in the query parameter.
    
    返回:
    
    Returns the value if a match is found; returns null otherwise.
    
    从以下版本开始:
    
    4
  - containParameter
```
public boolean containParameter(String paramName)
```
    Checks whether a query parameter pair exists based on the specified key.
    
    参数:
    
    paramName - Indicates the key of the query parameter pair to check.
    
    返回:
    
    Returns true if the query parameter pair exists; returns false otherwise.
    
    从以下版本开始:
    
    5
  - parseUrl
```
public void parseUrl(String url)
```
    Parses a specified URL.
    This method extracts the query string in the URL and then calls parseUrlQuery(java.lang.String) to parse the query string.
    
    参数:
    
    url - Indicates the URL to be parsed.
    
    抛出:
    
    NullPointerException - Throws this exception if the specific url is null.
    
    从以下版本开始:
    
    4
  - parseUrlQuery
```
public void parseUrlQuery(String query)
```
    Parses the specified query string of a URL.
    If no value is assigned to the key, the key-value pair of the query parameter will be parsed as an empty String.
    
    参数:
    
    query - Indicates the URL query string to be parsed.
    
    抛出:
    
    NullPointerException - Throws this exception if the specific query is null.
    
    从以下版本开始:
    
    4
  - registerParameterFilter
```
public void registerParameterFilter(String name,
                                    UrlQueryFilter.ValueFilter filter)
```
    Specifies a ValueFilter for a parameter key to filter out invalid characters of the value for this key.
    
    参数:
    
    name - Indicates the key of the parameter.
    
    filter - Indicates the ValueFilter to specify for the key. If the value is null, the ValueFilter of the key that is registered will be removed.
    
    从以下版本开始:
    
    4
  - getParameterFilter
```
public UrlQueryFilter.ValueFilter getParameterFilter(String name)
```
    Obtains the ValueFilter of a specified parameter key.
    If the parameter key is not registered, null is returned.
    
    参数:
    
    name - Indicates the key to obtain its ValueFilter.
    
    返回:
    
    Returns the ValueFilter if the parameter key has been registered; returns null if the key cannot be found.
    
    从以下版本开始:
    
    4
  - setUnregisteredParamFilter
```
public void setUnregisteredParamFilter(UrlQueryFilter.ValueFilter filter)
```
    Sets a ValueFilter for unregistered parameter keys.
    If no ValueFilter is set but unregistered parameters are allowed, the default ValueFilter will be used to filter out all special characters.
    
    参数:
    
    filter - Indicates the ValueFilter used to filter unregistered parameter values.
    
    从以下版本开始:
    
    4
  - getUnregisteredParamFilter
```
public UrlQueryFilter.ValueFilter getUnregisteredParamFilter()
```
    Obtains the ValueFilter that is used to filter out unregistered parameters.
    
    返回:
    
    Returns the ValueFilter.
    
    从以下版本开始:
    
    4
  - allowUnregisteredParameters
```
public void allowUnregisteredParameters(boolean allow)
```
    Sets whether to allow query of unregistered parameters.
    By default, unregistered parameters cannot be used for query.
    
    参数:
    
    allow - Specifies whether to allow query of unregistered parameters. The value true indicates that unregistered parameters are allowed, and false indicates the opposite.
    
    从以下版本开始:
    
    4
  - isAllowUnregisteredParameters
```
public boolean isAllowUnregisteredParameters()
```
    Checks whether to allow query of unregistered parameters.
    By default, unregistered parameters cannot be used for query.
    
    返回:
    
    Returns true if unregistered parameters are allowed; returns false otherwise.
    
    从以下版本开始:
    
    4
  - unescapeString
```
public String unescapeString(String str)
```
    Unescapes a specified string.
    This method replaces '+' in the string with ' ' and replaces escape characters '%xx' with the corresponding characters. Invalid escape characters will not be replaced.
    
    参数:
    
    str - Indicates the string to unescape.
    
    返回:
    
    Returns the unescaped string.
    
    从以下版本开始:
    
    5
  - parseParamPair
```
protected void parseParamPair(String name,
                              String value)
```
    Parses an escaped query parameter pair.
    This method can be overloaded. By default, the escaped parameter pair uses the ValueFilter of its key to filter its value. The filtered parameter pair is stored in the internal Map and List objects.
    
    参数:
    
    name - Indicates the key of the query parameter pair to parse.
    
    value - Indicates the value of the query parameter pair to parse.
    
    从以下版本开始:
    
    5
  - addParams
```
protected void addParams(Pair<String,String> entry)
```
    Adds a filtered parameter key-value pair to the internal List and Map objects.
    If the value parameter passed to the setFirstPriority(boolean) method is set to true, the value matching the first added key is used in the event of duplicate keys; otherwise, the value matching the last added key takes effect.
    
    参数:
    
    entry - Indicates the parameter key-value pair to add after filtering.
    
    从以下版本开始:
    
    5

类 UrlQueryFilter

嵌套类概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

UrlQueryFilter

方法详细资料

filterNulWithSpace

filterEncodedUrl

getParamsListFiltered

getParamsSetFiltered

setFirstPriority

getFirstPriority

getParamValue

containParameter

parseUrl

parseUrlQuery

registerParameterFilter

getParameterFilter

setUnregisteredParamFilter

getUnregisteredParamFilter

allowUnregisteredParameters

isAllowUnregisteredParameters

unescapeString

parseParamPair

addParams