com.palominolabs.http.url

Class PercentEncoder

java.lang.Object

com.palominolabs.http.url.PercentEncoder

@NotThreadSafe
public final class PercentEncoder
extends java.lang.Object

Encodes unsafe characters as a sequence of %XX hex-encoded bytes. This is typically done when encoding components of URLs. See UrlPercentEncoders for pre-configured PercentEncoder instances.

Constructor Summary

Constructors

Constructor and Description
PercentEncoder(java.util.BitSet safeChars, java.nio.charset.CharsetEncoder charsetEncoder)

Method Summary

Modifier and Type	Method and Description
java.lang.String	encode(java.lang.CharSequence input) Encode the input and return the resulting text as a String.
void	encode(java.lang.CharSequence input, PercentEncoderOutputHandler handler) Encode the input and pass output chars to a handler.

Methods inherited from class java.lang.Object

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

Constructor Detail

PercentEncoder

public PercentEncoder(@Nonnull
                      java.util.BitSet safeChars,
                      @Nonnull
                      java.nio.charset.CharsetEncoder charsetEncoder)

Parameters:

safeChars - the set of chars to NOT encode, stored as a bitset with the int positions corresponding to those chars set to true. Treated as read only.

charsetEncoder - charset encoder to encode characters with. Make sure to not re-use CharsetEncoder instances across threads.

Method Detail

encode

public void encode(@Nonnull
                   java.lang.CharSequence input,
                   @Nonnull
                   PercentEncoderOutputHandler handler)
            throws java.nio.charset.MalformedInputException,
                   java.nio.charset.UnmappableCharacterException

Encode the input and pass output chars to a handler.

Parameters:

input - input string

handler - handler to call on each output character

Throws:

java.nio.charset.MalformedInputException - if encoder is configured to report errors and malformed input is detected

java.nio.charset.UnmappableCharacterException - if encoder is configured to report errors and an unmappable character is detected

encode

@Nonnull
public java.lang.String encode(@Nonnull
                                        java.lang.CharSequence input)
                                 throws java.nio.charset.MalformedInputException,
                                        java.nio.charset.UnmappableCharacterException

Encode the input and return the resulting text as a String.

Parameters:

input - input string

Returns:

the input string with every character that's not in safeChars turned into its byte representation via the instance's encoder and then percent-encoded

Throws:

java.nio.charset.MalformedInputException - if encoder is configured to report errors and malformed input is detected

java.nio.charset.UnmappableCharacterException - if encoder is configured to report errors and an unmappable character is detected