Modifier and Type	Class and Description
private static class	StringCache.ByteEntry
private static class	StringCache.CharEntry

Modifier and Type	Field and Description
protected static int	accessCount Access count.
protected static volatile StringCache.ByteEntry[]	bcCache Cache for byte chunk.
protected static int	bcCount toString count for byte chunk.
protected static final HashMap<StringCache.ByteEntry, int[]>	bcStats Statistics hash map for byte chunk.
protected static boolean	byteEnabled Enabled ?
protected static int	cacheSize
protected static volatile StringCache.CharEntry[]	ccCache Cache for char chunk.
protected static int	ccCount toString count for char chunk.
protected static final HashMap<StringCache.CharEntry, int[]>	ccStats Statistics hash map for char chunk.
protected static boolean	charEnabled
protected static int	hitCount Hit count.
private static final Log	log
protected static final int	maxStringSize
private static final StringManager	sm
protected static int	trainThreshold

Access	Constructor and Description
public	StringCache()

Method Summary

Modifier and Type	Method and Description
protected static final int	Returns: -1, 0 or +1 if inferior, equal, or superior to the String. compare(ByteChunk The name to compare name, byte[] The compared to data compareTo) Compare given byte chunk with byte array.
protected static final int	Returns: -1, 0 or +1 if inferior, equal, or superior to the String. compare(CharChunk The name to compare name, char[] The compared to data compareTo) Compare given char chunk with char array.
protected static final String	Returns: the corresponding value find(ByteChunk The name to find name) Deprecated Unused. Find an entry given its name in the cache and return the associated String.
protected static final String	Returns: the corresponding value find(ByteChunk The name to find name, CodingErrorAction Action to take if an malformed input is encountered malformedInputAction, CodingErrorAction Action to take if an unmappable character is encountered unmappableCharacterAction) Find an entry given its name in the cache and return the associated String.
protected static final String	Returns: the corresponding value find(CharChunk The name to find name) Find an entry given its name in the cache and return the associated String.
protected static final int	Returns: the position of the best match findClosest(ByteChunk The name to find name, StringCache.ByteEntry[] The array in which to look array, int The effective length of the array len) Find an entry given its name in a sorted array of map elements.
protected static final int	Returns: the position of the best match findClosest(CharChunk The name to find name, StringCache.CharEntry[] The array in which to look array, int The effective length of the array len) Find an entry given its name in a sorted array of map elements.
public int	Returns: Returns the accessCount. getAccessCount()
public boolean	Returns: Returns the enabled. getByteEnabled()
public int	Returns: Returns the cacheSize. getCacheSize()
public boolean	Returns: Returns the enabled. getCharEnabled()
public int	Returns: Returns the hitCount. getHitCount()
public int	Returns: Returns the trainThreshold. getTrainThreshold()
public void	reset()
public void	setByteEnabled(boolean The enabled to set. byteEnabled)
public void	setCacheSize(int The cacheSize to set. cacheSize)
public void	setCharEnabled(boolean The enabled to set. charEnabled)
public void	setTrainThreshold(int The trainThreshold to set. trainThreshold)
public static String	toString(ByteChunk bc)
public static String	toString(ByteChunk bc, CodingErrorAction malformedInputAction, CodingErrorAction unmappableCharacterAction)
public static String	toString(CharChunk cc)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

accessCount	back to summary
protected static int accessCount Access count.

bcCache	back to summary
protected static volatile StringCache.ByteEntry[] bcCache Cache for byte chunk.

bcCount	back to summary
protected static int bcCount toString count for byte chunk.

bcStats	back to summary
protected static final HashMap<StringCache.ByteEntry, int[]> bcStats Statistics hash map for byte chunk.

byteEnabled	back to summary
protected static boolean byteEnabled Enabled ?

cacheSize	back to summary
protected static int cacheSize

ccCache	back to summary
protected static volatile StringCache.CharEntry[] ccCache Cache for char chunk.

ccCount	back to summary
protected static int ccCount toString count for char chunk.

ccStats	back to summary
protected static final HashMap<StringCache.CharEntry, int[]> ccStats Statistics hash map for char chunk.

charEnabled	back to summary
protected static boolean charEnabled

hitCount	back to summary
protected static int hitCount Hit count.

log	back to summary
private static final Log log

maxStringSize	back to summary
protected static final int maxStringSize

sm	back to summary
private static final StringManager sm

trainThreshold	back to summary
protected static int trainThreshold

StringCache	back to summary
public StringCache()

Method Detail

compare	back to summary
protected static final int compare(ByteChunk name, byte[] compareTo) Compare given byte chunk with byte array. Parameters name:ByteChunk The name to compare compareTo:byte[] The compared to data Returns:int -1, 0 or +1 if inferior, equal, or superior to the String.

compare

back to summary

protected static final int compare(ByteChunk name, byte[] compareTo)

Compare given byte chunk with byte array.

Parameters

name:ByteChunk: The name to compare
compareTo:byte[]: The compared to data

Returns:int

-1, 0 or +1 if inferior, equal, or superior to the String.

compare	back to summary
protected static final int compare(CharChunk name, char[] compareTo) Compare given char chunk with char array. Parameters name:CharChunk The name to compare compareTo:char[] The compared to data Returns:int -1, 0 or +1 if inferior, equal, or superior to the String.

compare

back to summary

protected static final int compare(CharChunk name, char[] compareTo)

Compare given char chunk with char array.

Parameters

name:CharChunk: The name to compare
compareTo:char[]: The compared to data

Returns:int

-1, 0 or +1 if inferior, equal, or superior to the String.

find back to summary

find	back to summary
protected static final String find(ByteChunk name) Deprecated Unused. Will be removed in Tomcat 11. Use `find(ByteChunk, CodingErrorAction, CodingErrorAction)` Find an entry given its name in the cache and return the associated String. Parameters name:ByteChunk The name to find Returns:String the corresponding value Annotations @Deprecated

protected static final String find(ByteChunk name)

Deprecated

Unused. Will be removed in Tomcat 11. Use find(ByteChunk, CodingErrorAction, CodingErrorAction)

Find an entry given its name in the cache and return the associated String.

Parameters

name:ByteChunk: The name to find

Returns:String

the corresponding value

Annotations

@Deprecated

find	back to summary
protected static final String find(ByteChunk name, CodingErrorAction malformedInputAction, CodingErrorAction unmappableCharacterAction) Find an entry given its name in the cache and return the associated String. Parameters name:ByteChunk The name to find malformedInputAction:CodingErrorAction Action to take if an malformed input is encountered unmappableCharacterAction:CodingErrorAction Action to take if an unmappable character is encountered Returns:String the corresponding value

find

back to summary

protected static final String find(ByteChunk name, CodingErrorAction malformedInputAction, CodingErrorAction unmappableCharacterAction)

Find an entry given its name in the cache and return the associated String.

Parameters

name:ByteChunk: The name to find
malformedInputAction:CodingErrorAction: Action to take if an malformed input is encountered
unmappableCharacterAction:CodingErrorAction: Action to take if an unmappable character is encountered

Returns:String

the corresponding value

find	back to summary
protected static final String find(CharChunk name) Find an entry given its name in the cache and return the associated String. Parameters name:CharChunk The name to find Returns:String the corresponding value

find

back to summary

protected static final String find(CharChunk name)

Find an entry given its name in the cache and return the associated String.

Parameters

name:CharChunk: The name to find

Returns:String

the corresponding value

findClosest	back to summary
protected static final int findClosest(ByteChunk name, StringCache.ByteEntry[] array, int len) Find an entry given its name in a sorted array of map elements. This will return the index for the closest inferior or equal item in the given array. Parameters name:ByteChunk The name to find array:StringCache.ByteEntry[] The array in which to look len:int The effective length of the array Returns:int the position of the best match

findClosest

back to summary

protected static final int findClosest(ByteChunk name, StringCache.ByteEntry[] array, int len)

Find an entry given its name in a sorted array of map elements. This will return the index for the closest inferior or equal item in the given array.

Parameters

name:ByteChunk: The name to find
array:StringCache.ByteEntry[]: The array in which to look
len:int: The effective length of the array

Returns:int

the position of the best match

findClosest	back to summary
protected static final int findClosest(CharChunk name, StringCache.CharEntry[] array, int len) Find an entry given its name in a sorted array of map elements. This will return the index for the closest inferior or equal item in the given array. Parameters name:CharChunk The name to find array:StringCache.CharEntry[] The array in which to look len:int The effective length of the array Returns:int the position of the best match

findClosest

back to summary

protected static final int findClosest(CharChunk name, StringCache.CharEntry[] array, int len)

Find an entry given its name in a sorted array of map elements. This will return the index for the closest inferior or equal item in the given array.

Parameters

name:CharChunk: The name to find
array:StringCache.CharEntry[]: The array in which to look
len:int: The effective length of the array

Returns:int

the position of the best match

getAccessCount	back to summary
public int getAccessCount() Returns:int Returns the accessCount.

getByteEnabled	back to summary
public boolean getByteEnabled() Returns:boolean Returns the enabled.

getCacheSize	back to summary
public int getCacheSize() Returns:int Returns the cacheSize.

getCharEnabled	back to summary
public boolean getCharEnabled() Returns:boolean Returns the enabled.

getHitCount	back to summary
public int getHitCount() Returns:int Returns the hitCount.

getTrainThreshold	back to summary
public int getTrainThreshold() Returns:int Returns the trainThreshold.

reset	back to summary
public void reset()

setByteEnabled	back to summary
public void setByteEnabled(boolean byteEnabled) Parameters byteEnabled:boolean The enabled to set.

setCacheSize	back to summary
public void setCacheSize(int cacheSize) Parameters cacheSize:int The cacheSize to set.

setCharEnabled	back to summary
public void setCharEnabled(boolean charEnabled) Parameters charEnabled:boolean The enabled to set.

setTrainThreshold	back to summary
public void setTrainThreshold(int trainThreshold) Parameters trainThreshold:int The trainThreshold to set.

toString	back to summary
public static String toString(ByteChunk bc)

toString	back to summary
public static String toString(ByteChunk bc, CodingErrorAction malformedInputAction, CodingErrorAction unmappableCharacterAction) throws CharacterCodingException

toString	back to summary
public static String toString(CharChunk cc)

org.apache.tomcat.util.buf back to summary

private Class StringCache.ByteEntry

Class Inheritance

extends Object

java.lang.Object
org.apache.tomcat.util.buf.StringCache.ByteEntry

Field Summary

Modifier and Type	Field and Description
private Charset	charset
private CodingErrorAction	malformedInputAction
private byte[]	name
private CodingErrorAction	unmappableCharacterAction
private String	value

Constructor Summary

Access	Constructor and Description
private	ByteEntry()

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

charset	back to summary
private Charset charset

malformedInputAction	back to summary
private CodingErrorAction malformedInputAction

name	back to summary
private byte[] name

unmappableCharacterAction	back to summary
private CodingErrorAction unmappableCharacterAction

value	back to summary
private String value

Constructor Detail

ByteEntry	back to summary
private ByteEntry()

Method Detail

equals back to summary

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

hashCode back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

org.apache.tomcat.util.buf back to summary

private Class StringCache.CharEntry

Class Inheritance

extends Object

java.lang.Object
org.apache.tomcat.util.buf.StringCache.CharEntry

Field Summary

Modifier and Type	Field and Description
private char[]	name
private String	value

Constructor Summary

Access	Constructor and Description
private	CharEntry()

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

name	back to summary
private char[] name

value	back to summary
private String value

Constructor Detail

CharEntry	back to summary
private CharEntry()

Method Detail

equals back to summary

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

hashCode back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public Class StringCache

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class StringCache.ByteEntry

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class StringCache.CharEntry

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail