UrlQuery (ujava-common 7.0.0 API)

java.lang.Object
- cn.ujava.common.net.url.UrlQuery

```
public class UrlQuery
extends Object
```
URL中查询字符串部分的封装，类似于：
```
   key1=v1&key2=&key3=v3
 
```
查询封装分为解析查询字符串和构建查询字符串，解析可通过charset为null来自定义是否decode编码后的内容，
构建则通过charset是否为null是否encode参数键值对
作者:

ujava

从以下版本开始:

5.3.1

嵌套类概要

嵌套类
限定符和类型类和说明

static class UrlQuery.EncodeMode
编码模式
根据不同场景以及不同环境，对Query中的name和value采用不同的编码策略

嵌套类
限定符和类型	类和说明
`static class`	`UrlQuery.EncodeMode` 编码模式根据不同场景以及不同环境，对Query中的name和value采用不同的编码策略

构造器概要

构造器
构造器和说明

UrlQuery(Map<? extends CharSequence,?> queryMap, UrlQuery.EncodeMode encodeMode)
构造

构造器
构造器和说明
`UrlQuery(Map<? extends CharSequence,?> queryMap, UrlQuery.EncodeMode encodeMode)` 构造

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`UrlQuery`	`add(CharSequence key, Object value)` 增加键值对
`UrlQuery`	`addAll(Map<? extends CharSequence,?> queryMap)` 批量增加键值对
`String`	`build(Charset charset)` 构建URL查询字符串，即将key-value键值对转换为`key1=v1&key2=v2&key3=v3`形式。
`String`	`build(Charset charset, boolean encodePercent)` 构建URL查询字符串，即将key-value键值对转换为`key1=v1&key2=v2&key3=v3`形式。
`String`	`build(PercentCodec keyCoder, PercentCodec valueCoder, Charset charset)` 构建URL查询字符串，即将key-value键值对转换为`key1=v1&key2=v2&key3=v3`形式。
`String`	`build(PercentCodec keyCoder, PercentCodec valueCoder, Charset charset, boolean encodePercent)` 构建URL查询字符串，即将key-value键值对转换为`key1=v1&key2=v2&key3=v3`形式。
`CharSequence`	`get(CharSequence key)` 获取查询值
`Map<CharSequence,CharSequence>`	`getQueryMap()` 获得查询的Map
`static UrlQuery`	`of()` 构建UrlQuery
`static UrlQuery`	`of(Map<? extends CharSequence,?> queryMap)` 构建UrlQuery
`static UrlQuery`	`of(Map<? extends CharSequence,?> queryMap, UrlQuery.EncodeMode encodeMode)` 构建UrlQuery
`static UrlQuery`	`of(String queryStr, Charset charset)` 构建UrlQuery
`static UrlQuery`	`of(String queryStr, Charset charset, boolean autoRemovePath)` 构建UrlQuery
`static UrlQuery`	`of(String queryStr, Charset charset, boolean autoRemovePath, UrlQuery.EncodeMode encodeMode)` 构建UrlQuery
`static UrlQuery`	`of(UrlQuery.EncodeMode encodeMode)` 构建UrlQuery
`UrlQuery`	`parse(String queryStr, Charset charset)` 解析URL中的查询字符串
`UrlQuery`	`parse(String queryStr, Charset charset, boolean autoRemovePath)` 解析URL中的查询字符串
`UrlQuery`	`setEncodeMode(UrlQuery.EncodeMode encodeMode)` 设置编码模式根据不同场景以及不同环境，对Query中的name和value采用不同的编码策略
`String`	`toString()` 生成查询字符串，类似于aaa=111&bbb=222 此方法不对任何特殊字符编码，仅用于输出显示

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

- 构造器详细资料
  - UrlQuery
```
public UrlQuery(Map<? extends CharSequence,?> queryMap,
                UrlQuery.EncodeMode encodeMode)
```
    构造
    
    参数:
    
    queryMap - 初始化的查询键值对
    
    encodeMode - 编码模式
- 方法详细资料
  - of
```
public static UrlQuery of(String queryStr,
                          Charset charset)
```
    构建UrlQuery
    
    参数:
    
    queryStr - 初始化的查询字符串
    
    charset - decode用的编码，null表示不做decode
    
    返回:
    
    UrlQuery
  - of
```
public static UrlQuery of(String queryStr,
                          Charset charset,
                          boolean autoRemovePath)
```
    构建UrlQuery
    
    参数:
    
    queryStr - 初始化的查询字符串
    
    charset - decode用的编码，null表示不做decode
    
    autoRemovePath - 是否自动去除path部分，true则自动去除第一个?前的内容
    
    返回:
    
    UrlQuery
    
    从以下版本开始:
    
    5.5.8
  - of
```
public static UrlQuery of(String queryStr,
                          Charset charset,
                          boolean autoRemovePath,
                          UrlQuery.EncodeMode encodeMode)
```
    构建UrlQuery
    
    参数:
    
    queryStr - 初始化的查询字符串
    
    charset - decode用的编码，null表示不做decode
    
    autoRemovePath - 是否自动去除path部分，true则自动去除第一个?前的内容
    
    encodeMode - 编码模式。
    
    返回:
    
    UrlQuery
  - of
```
public static UrlQuery of()
```
    构建UrlQuery
    
    返回:
    
    UrlQuery
  - of
```
public static UrlQuery of(UrlQuery.EncodeMode encodeMode)
```
    构建UrlQuery
    
    参数:
    
    encodeMode - 编码模式
    
    返回:
    
    UrlQuery
  - of
```
public static UrlQuery of(Map<? extends CharSequence,?> queryMap)
```
    构建UrlQuery
    
    参数:
    
    queryMap - 初始化的查询键值对
    
    返回:
    
    UrlQuery
  - of
```
public static UrlQuery of(Map<? extends CharSequence,?> queryMap,
                          UrlQuery.EncodeMode encodeMode)
```
    构建UrlQuery
    
    参数:
    
    queryMap - 初始化的查询键值对
    
    encodeMode - 编码模式
    
    返回:
    
    UrlQuery
  - setEncodeMode
```
public UrlQuery setEncodeMode(UrlQuery.EncodeMode encodeMode)
```
    设置编码模式
    根据不同场景以及不同环境，对Query中的name和value采用不同的编码策略
    
    参数:
    
    encodeMode - 编码模式
    
    返回:
    
    this
    
    从以下版本开始:
    
    6.0.0
  - add
```
public UrlQuery add(CharSequence key,
                    Object value)
```
    增加键值对
    
    参数:
    
    key - 键
    
    value - 值，集合和数组转换为逗号分隔形式
    
    返回:
    
    this
  - addAll
```
public UrlQuery addAll(Map<? extends CharSequence,?> queryMap)
```
    批量增加键值对
    
    参数:
    
    queryMap - query中的键值对
    
    返回:
    
    this
  - parse
```
public UrlQuery parse(String queryStr,
                      Charset charset)
```
    解析URL中的查询字符串
    
    参数:
    
    queryStr - 查询字符串，类似于key1=v1&key2=&key3=v3
    
    charset - decode编码，null表示不做decode
    
    返回:
    
    this
  - parse
```
public UrlQuery parse(String queryStr,
                      Charset charset,
                      boolean autoRemovePath)
```
    解析URL中的查询字符串
    
    参数:
    
    queryStr - 查询字符串，类似于key1=v1&key2=&key3=v3
    
    charset - decode编码，null表示不做decode
    
    autoRemovePath - 是否自动去除path部分，true则自动去除第一个?前的内容
    
    返回:
    
    this
    
    从以下版本开始:
    
    5.5.8
  - getQueryMap
```
public Map<CharSequence,CharSequence> getQueryMap()
```
    获得查询的Map
    
    返回:
    
    查询的Map，只读
  - get
```
public CharSequence get(CharSequence key)
```
    获取查询值
    
    参数:
    
    key - 键
    
    返回:
    
    值
  - build
```
public String build(Charset charset)
```
    构建URL查询字符串，即将key-value键值对转换为key1=v1&key2=v2&key3=v3形式。
    对于null处理规则如下：
    - 如果key为null，则这个键值对忽略
    - 如果value为null，只保留key，如key1对应value为null生成类似于key1&key2=v2形式
    参数:
    
    charset - encode编码，null表示不做encode编码
    
    返回:
    
    URL查询字符串
  - build
```
public String build(Charset charset,
                    boolean encodePercent)
```
    构建URL查询字符串，即将key-value键值对转换为key1=v1&key2=v2&key3=v3形式。
    对于null处理规则如下：
    - 如果key为null，则这个键值对忽略
    - 如果value为null，只保留key，如key1对应value为null生成类似于key1&key2=v2形式
    参数:
    
    charset - encode编码，null表示不做encode编码
    
    encodePercent - 是否编码`%`
    
    返回:
    
    URL查询字符串
  - build
```
public String build(PercentCodec keyCoder,
                    PercentCodec valueCoder,
                    Charset charset)
```
    构建URL查询字符串，即将key-value键值对转换为key1=v1&key2=v2&key3=v3形式。
    对于null处理规则如下：
    - 如果key为null，则这个键值对忽略
    - 如果value为null，只保留key，如key1对应value为null生成类似于key1&key2=v2形式
    参数:
    
    keyCoder - 键值对中键的编码器
    
    valueCoder - 键值对中值的编码器
    
    charset - encode编码，null表示不做encode编码
    
    返回:
    
    URL查询字符串
    
    从以下版本开始:
    
    5.7.16
  - build
```
public String build(PercentCodec keyCoder,
                    PercentCodec valueCoder,
                    Charset charset,
                    boolean encodePercent)
```
    构建URL查询字符串，即将key-value键值对转换为key1=v1&key2=v2&key3=v3形式。
    对于null处理规则如下：
    - 如果key为null，则这个键值对忽略
    - 如果value为null，只保留key，如key1对应value为null生成类似于key1&key2=v2形式
    参数:
    
    keyCoder - 键值对中键的编码器
    
    valueCoder - 键值对中值的编码器
    
    charset - encode编码，null表示不做encode编码
    
    encodePercent - 是否编码`%`
    
    返回:
    
    URL查询字符串
    
    从以下版本开始:
    
    5.8.0
  - toString
```
public String toString()
```
    生成查询字符串，类似于aaa=111&bbb=222
    此方法不对任何特殊字符编码，仅用于输出显示
    
    覆盖:
    
    toString 在类中 Object
    
    返回:
    
    查询字符串

类 UrlQuery

嵌套类概要

构造器概要

方法概要

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

构造器详细资料

UrlQuery

方法详细资料

of

of

of

of

of

of

of

setEncodeMode

add

addAll

parse

parse

getQueryMap

get

build

build

build

build

toString