com.jn.langx.net.escaper

类 PercentEscaper

java.lang.Object

com.jn.langx.escape.Escaper

com.jn.langx.escape.UnicodeEscaper

com.jn.langx.net.escaper.PercentEscaper

public final class PercentEscaper
extends UnicodeEscaper

A UnicodeEscaper that escapes some set of Java characters using a UTF-8 based percent encoding scheme. The set of safe characters (those which remain unescaped) can be specified on construction.

This class is primarily used for creating URI escapers in UrlEscapers but can be used directly if required. While URI escapers impose specific semantics on which characters are considered 'safe', this class has a minimal set of restrictions.

When escaping a String, the following rules apply:

• All specified safe characters remain unchanged.
• If plusForSpace was specified, the space character " " is converted into a plus sign "+".
• All other characters are converted into one or more bytes using UTF-8 encoding and each byte is then represented by the 3-character string "%XX", where "XX" is the two-digit, uppercase, hexadecimal representation of the byte value.

For performance reasons the only currently supported character encoding of this class is UTF-8.

Note: This escaper produces uppercase hexadecimal sequences.

构造器概要

构造器

构造器和说明
PercentEscaper(String safeChars, boolean plusForSpace) Constructs a percent escaper with the specified safe characters and optional handling of the space character.

方法概要

限定符和类型	方法和说明
protected char[]	escape(int cp) Escapes the given Unicode code point in UTF-8.
String	escape(String s) Overridden for performance.
protected int	nextEscapeIndex(CharSequence csq, int index, int end) Overridden for performance.

从类继承的方法 com.jn.langx.escape.UnicodeEscaper

codePointAt, escapeSlow

从类继承的方法 com.jn.langx.escape.Escaper

asFunction

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

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

构造器详细资料

PercentEscaper

public PercentEscaper(String safeChars,
                      boolean plusForSpace)

Constructs a percent escaper with the specified safe characters and optional handling of the space character.

Not that it is allowed, but not necessarily desirable to specify % as a safe character. This has the effect of creating an escaper which has no well defined inverse but it can be useful when escaping additional characters.

参数:

safeChars - a non null string specifying additional safe characters for this escaper (the ranges 0..9, a..z and A..Z are always safe and should not be specified here)

plusForSpace - true if ASCII space should be escaped to + rather than %20

抛出:

IllegalArgumentException - if any of the parameters were invalid

方法详细资料

nextEscapeIndex

protected int nextEscapeIndex(CharSequence csq,
                              int index,
                              int end)

Overridden for performance. For unescaped strings this improved the performance of the uri escaper from ~760ns to ~400ns as measured by {CharEscapersBenchmark}.

覆盖:

nextEscapeIndex 在类中 UnicodeEscaper

参数:

csq - a sequence of characters

index - the index of the first character to be scanned

end - the index immediately after the last character to be scanned

escape

public String escape(String s)

Overridden for performance. For unescaped strings this improved the performance of the uri escaper from ~400ns to ~170ns as measured by {CharEscapersBenchmark}.

覆盖:

escape 在类中 UnicodeEscaper

参数:

s - the literal string to be escaped

返回:

the escaped form of string

escape

protected char[] escape(int cp)

Escapes the given Unicode code point in UTF-8.

指定者:

escape 在类中 UnicodeEscaper

参数:

cp - the Unicode code point to escape if necessary

返回:

the replacement characters, or null if no escaping was needed