Field Detail

• UTF8

  private static final Charset UTF8

• HEX

  private static final char[] HEX

• ALPHANUM_CHARS

  private static final String ALPHANUM_CHARS

  See Also:

  Constant Field Values

• MARK_CHARS

  private static final String MARK_CHARS

  See Also:

  Constant Field Values

• DEFAULT_LEGAL_CHARS

  private static final String DEFAULT_LEGAL_CHARS

  See Also:

  Constant Field Values

• encoder

  @CheckForNull
  private final CharsetEncoder encoder

• stringBuilder

  @CheckForNull
  private StringBuilder stringBuilder

Constructor Detail

• UriEncoder

  public UriEncoder()

  Constructs a new URI codec which uses the UTF-8 character set to encode non-US-ASCII characters.

• UriEncoder

  public UriEncoder(@CheckForNull
            Charset charset)

  Constructs a new URI codec which uses the given character set to encode non-US-ASCII characters.

  Parameters:

  charset - the character set to use for encoding non-US-ASCII characters. If this is null, then this codec preserves non-US-ASCII characters. Note that using any other character set than UTF-8 should void interoperability with most applications!

Method Detail

• quote

  private static void quote(char dc,
           StringBuilder eS)

• quote

  private static void quote(ByteBuffer eB,
           StringBuilder eS)

• encode

  public String encode(String dS,
              UriEncoder.Encoding comp)

  Encodes all characters in the string dS which are illegal within the URI component comp.

  Note that calling this method on an already encoded string escapes any escape sequences again, that is, each occurence of the character '%' is substituted with the string "%25" again.

  Parameters:

  dS - the decoded string to encode.

  comp - the URI component to encode.

  Returns:

  The encoded string.

  Throws:

  IllegalArgumentException - on any encoding error with a URISyntaxException as its cause. This exception should never occur if the character set of this codec is UTF-8.

• encode

  @CheckForNull
  public StringBuilder encode(String dS,
                                  UriEncoder.Encoding comp,
                                  @CheckForNull
                                  StringBuilder eS)
                       throws URISyntaxException

  Encodes all characters in the string dS which are illegal within the URI component comp to the string builder eS.

  Note that calling this method on an already encoded string escapes any escape sequences again, that is, each occurence of the character '%' is substituted with the string "%25" again.

  Parameters:

  dS - the decoded string to encode.

  comp - the URI component to encode.

  eS - the string builder to which all encoded characters shall get appended.

  Returns:

  If dS contains only legal characters for the URI component comp, then null gets returned. Otherwise, if eS is not null, then it gets returned with all encoded characters appended to it. Otherwise, a temporary string builder gets returned which solely contains all encoded characters. This temporary string builder may get cleared and reused upon the next call to any method of this object.

  Throws:

  URISyntaxException - on any encoding error. This exception should never occur if the character set of this codec is UTF-8. If it occurs however, eS is left in an undefined state.