UEncoder (Apache Tomcat 7.0.109 API Documentation)

Apache Tomcat 7.0.109

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.apache.tomcat.util.buf.UEncoder

```
public final class UEncoder
extends Object
```
Efficient implementation for encoders. This class is not thread safe - you need one encoder per thread. The encoder will save and recycle the internal objects, avoiding garbage. You can add extra characters that you want preserved, for example while encoding a URL you can add "/".

Author:

Costin Manolache

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class UEncoder.SafeCharsSet

Constructor Summary

Constructors
Constructor and Description

UEncoder()

UEncoder(UEncoder.SafeCharsSet safeCharsSet)
Create a UEncoder with an unmodifiable safe character set.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addSafeCharacter(char c)`
`CharChunk`	`encodeURL(String s, int start, int end)` URL Encode string, using a specified encoding.
`void`	`setEncoding(String s)` Deprecated. Unused. Will be removed in Tomcat 8.0.x onwards.
`protected void`	`urlEncode(CharChunk out, ByteChunk bb)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - UEncoder
```
public UEncoder()
```
  - UEncoder
```
public UEncoder(UEncoder.SafeCharsSet safeCharsSet)
```
    Create a UEncoder with an unmodifiable safe character set.
    Calls to addSafeCharacter(char) on instances created by this constructor will throw an IllegalStateException.
    
    Parameters:
    safeCharsSet - safe characters for this encoder
- Method Detail
  - setEncoding
```
@Deprecated
public void setEncoding(String s)
```
    Deprecated. Unused. Will be removed in Tomcat 8.0.x onwards.
    
    Parameters:
    s - Encoding to use
  - addSafeCharacter
```
public void addSafeCharacter(char c)
```
  - encodeURL
```
public CharChunk encodeURL(String s,
                  int start,
                  int end)
                    throws IOException
```
    URL Encode string, using a specified encoding.
    
    Parameters:
    s - string to be encoded
    start - the beginning index, inclusive
    end - the ending index, exclusive
    
    Returns:
    A new CharChunk contained the URL encoded string
    
    Throws:
    
    IOException - If an I/O error occurs
  - urlEncode
```
protected void urlEncode(CharChunk out,
             ByteChunk bb)
                  throws IOException
```
    Throws:
    
    IOException

Apache Tomcat 7.0.109

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2000-2021 Apache Software Foundation. All Rights Reserved.