org.owasp.encoder

Class CSSEncoder

java.lang.Object

org.owasp.encoder.Encoder

org.owasp.encoder.CSSEncoder

class CSSEncoder
extends Encoder

CSSEncoder -- Encoder for Cascading-Style-Sheet string and URI contexts. Other contexts, such as color, number (w/unit), etc... are not good targets for "encoding" (e.g. you cannot encode the string "XYZ" into a number), they should instead by validated through other means (such as regular expressions).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	CSSEncoder.Mode Encoding mode of operation--specified the set of characters that required encoding.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) long	_highMask The bit-mask of unescaped characters in the range 64 to 127.
(package private) long	_lowMask The bit-mask of unescaped characters in the range 0 to 63.
(package private) CSSEncoder.Mode	_mode The mode of operation, used primarily for toString.
(package private) static int	HEX_ENCODED_LENGTH Length of hex encoding with trailing space "\## ".
(package private) static char	INVALID_REPLACEMENT_CHARACTER Character used when an invalid characters is found.
(package private) static int	LONG_BITS Number of bits in a long.

Fields inherited from class org.owasp.encoder.Encoder

HEX, HEX_MASK, HEX_SHIFT

Constructor Summary

Constructors

Constructor and Description
CSSEncoder(CSSEncoder.Mode mode) Creates an encoder for the specified mode of operation.

Method Summary

Modifier and Type	Method and Description
protected java.nio.charset.CoderResult	encodeArrays(java.nio.CharBuffer input, java.nio.CharBuffer output, boolean endOfInput) The core encoding loop used when both the input and output buffers are array backed.
protected int	firstEncodedOffset(java.lang.String input, int off, int len) Scans the input string for the first character index that requires encoding.
protected int	maxEncodedLength(int n) Returns the maximum encoded length (in chars) of an input sequence of n characters.
java.lang.String	toString()

Methods inherited from class org.owasp.encoder.Encoder

encode, encodeBuffers, overflow, underflow

Methods inherited from class java.lang.Object

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

Field Detail

LONG_BITS

static final int LONG_BITS

Number of bits in a long.

See Also:

Constant Field Values

HEX_ENCODED_LENGTH

static final int HEX_ENCODED_LENGTH

Length of hex encoding with trailing space "\## ".

See Also:

Constant Field Values

INVALID_REPLACEMENT_CHARACTER

static final char INVALID_REPLACEMENT_CHARACTER

Character used when an invalid characters is found. Invalid characters may not appear with or without encoding.

See Also:

Constant Field Values

_lowMask

final long _lowMask

The bit-mask of unescaped characters in the range 0 to 63.

_highMask

final long _highMask

The bit-mask of unescaped characters in the range 64 to 127.

_mode

final CSSEncoder.Mode _mode

The mode of operation, used primarily for toString.

Constructor Detail

CSSEncoder

CSSEncoder(CSSEncoder.Mode mode)

Creates an encoder for the specified mode of operation.

Parameters:

mode - the mode of the encoder.

Method Detail

maxEncodedLength

protected int maxEncodedLength(int n)

Description copied from class: Encoder

Returns the maximum encoded length (in chars) of an input sequence of n characters.

Specified by:

maxEncodedLength in class Encoder

Parameters:

n - the number of characters of input

Returns:

the worst-case number of characters required to encode

firstEncodedOffset

protected int firstEncodedOffset(java.lang.String input,
                                 int off,
                                 int len)

Description copied from class: Encoder

Scans the input string for the first character index that requires encoding. If the entire input does not require encoding then the length is returned. This method is used by the Encode.forXYZ methods to return input strings unchanged when possible.

Specified by:

firstEncodedOffset in class Encoder

Parameters:

input - the input to check for encoding

off - the offset of the first character to check

len - the number of characters to check

Returns:

the index of the first character to encode. The return value will be off+len if no characters in the input require encoding.

encodeArrays

protected java.nio.charset.CoderResult encodeArrays(java.nio.CharBuffer input,
                                                    java.nio.CharBuffer output,
                                                    boolean endOfInput)

Description copied from class: Encoder

The core encoding loop used when both the input and output buffers are array backed. The loop is expected to fetch the arrays and interact with the arrays directly for performance.

Overrides:

encodeArrays in class Encoder

Parameters:

input - the input buffer.

output - the output buffer.

endOfInput - when true, this is the last input to encode

Returns:

UNDERFLOW or OVERFLOW

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object