Extends the abstract Constant to represent a reference to a UTF-8 encoded string.

The following system properties govern caching this class performs.

SYS_PROP_CACHE_MAX_ENTRIES (since 6.4): The size of the cache, by default 0, meaning caching is disabled.
SYS_PROP_CACHE_MAX_ENTRY_SIZE (since 6.0): The maximum size of the values to cache, by default 200, 0 disables caching. Values larger than this are not cached.
SYS_PROP_STATISTICS (since 6.0): Prints statistics on the console when the JVM exits.

Here is a sample Maven invocation with caching disabled:

mvn test -Dbcel.statistics=true -Dbcel.maxcached.size=0 -Dbcel.maxcached=0

Here is a sample Maven invocation with caching enabled:

mvn test -Dbcel.statistics=true -Dbcel.maxcached.size=100000 -Dbcel.maxcached=5000000

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	ConstantUtf8.Cache

Field Summary

Modifier and Type	Field and Description
private static volatile int	considered
private static volatile int	created
private static volatile int	hits
private static volatile int	skipped
private static final String	SYS_PROP_CACHE_MAX_ENTRIES
private static final String	SYS_PROP_CACHE_MAX_ENTRY_SIZE
private static final String	SYS_PROP_STATISTICS
private final String	value

Inherited from org.apache.bcel.classfile.Constant:: tag

Constructor Summary

Access	Constructor and Description
public	ConstantUtf8(final ConstantUtf8 the value. constantUtf8) Initializes from another object.
pack-priv	ConstantUtf8(final DataInput Input stream dataInput) Initializes instance from file data.
public	ConstantUtf8(final String Data value)

Method Summary

Modifier and Type	Method and Description
public void	accept(final Visitor Visitor object v) Implements abstract org.apache.bcel.classfile.Constant.accept. Implements org.apache.bcel.classfile.Node.accept. Called by objects that are traversing the nodes of the tree implicitly defined by the contents of a Java class.
public static synchronized void	clearCache() Clears the cache.
pack-priv static synchronized void	clearStats()
private static void	countCreated()
public void	dump(final DataOutputStream Output file stream file) Implements abstract org.apache.bcel.classfile.Constant.dump. Dumps String in Utf8 format to file stream.
public String	Returns: Data converted to string. getBytes()
public static ConstantUtf8	Returns: a new or cached instance of the given value. getCachedInstance(final String the value. value) Gets a new or cached instance of the given value.
public static ConstantUtf8	Returns: a new or cached instance of the given value. getInstance(final DataInput the value. dataInput) Gets a new or cached instance of the given value.
public static ConstantUtf8	Returns: a new or cached instance of the given value. getInstance(final String the value. value) Gets a new or cached instance of the given value.
pack-priv static void	printStats()
public void	setBytes(final String the raw bytes of this UTF-8 bytes) Deprecated (since 6.0)
public String	Returns: String representation toString() Overrides org.apache.bcel.classfile.Constant.toString. Returns a string representation of the object.

Inherited from org.apache.bcel.classfile.Constant:: clone copy equals getComparator getTag hashCode readConstant setComparator

Field Detail

considered	back to summary
private static volatile int considered

created	back to summary
private static volatile int created

hits	back to summary
private static volatile int hits

skipped	back to summary
private static volatile int skipped

SYS_PROP_CACHE_MAX_ENTRIES	back to summary
private static final String SYS_PROP_CACHE_MAX_ENTRIES

SYS_PROP_CACHE_MAX_ENTRY_SIZE	back to summary
private static final String SYS_PROP_CACHE_MAX_ENTRY_SIZE

SYS_PROP_STATISTICS	back to summary
private static final String SYS_PROP_STATISTICS

value	back to summary
private final String value

Constructor Detail

ConstantUtf8	back to summary
public ConstantUtf8(final ConstantUtf8 constantUtf8) Initializes from another object. Parameters constantUtf8:ConstantUtf8 the value.

ConstantUtf8

back to summary

public ConstantUtf8(final ConstantUtf8 constantUtf8)

Initializes from another object.

Parameters

constantUtf8:ConstantUtf8: the value.

ConstantUtf8	back to summary
pack-priv ConstantUtf8(final DataInput dataInput) throws IOException Initializes instance from file data. Parameters dataInput:DataInput Input stream Exceptions IOException: if an I/O error occurs.

ConstantUtf8

back to summary

pack-priv ConstantUtf8(final DataInput dataInput) throws IOException

Initializes instance from file data.

Parameters

dataInput:DataInput: Input stream

Exceptions

IOException:: if an I/O error occurs.

ConstantUtf8	back to summary
public ConstantUtf8(final String value) Parameters value:String Data

Method Detail

accept	back to summary
public void accept(final Visitor v) Implements abstract org.apache.bcel.classfile.Constant.accept. Implements org.apache.bcel.classfile.Node.accept. Called by objects that are traversing the nodes of the tree implicitly defined by the contents of a Java class. I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree of objects. Parameters v:Visitor Visitor object Annotations @Override

back to summary

public void accept(final Visitor v)

Implements abstract org.apache.bcel.classfile.Constant.accept.

Implements org.apache.bcel.classfile.Node.accept.

Called by objects that are traversing the nodes of the tree implicitly defined by the contents of a Java class. I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree of objects.

Parameters

v:Visitor: Visitor object

Annotations

@Override

clearCache	back to summary
public static synchronized void clearCache() Clears the cache. Since 6.4.0

clearCache

back to summary

public static synchronized void clearCache()

Clears the cache.

Since: 6.4.0

clearStats	back to summary
pack-priv static synchronized void clearStats()

countCreated	back to summary
private static void countCreated()

dump	back to summary
public void dump(final DataOutputStream file) throws IOException Implements abstract org.apache.bcel.classfile.Constant.dump. Dumps String in Utf8 format to file stream. Parameters file:DataOutputStream Output file stream Annotations @Override Exceptions IOException: if an I/O error occurs.

dump

back to summary

public void dump(final DataOutputStream file) throws IOException

Implements abstract org.apache.bcel.classfile.Constant.dump.

Dumps String in Utf8 format to file stream.

Parameters

file:DataOutputStream: Output file stream

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

getBytes	back to summary
public String getBytes() Returns:String Data converted to string.

getCachedInstance back to summary

getCachedInstance	back to summary
public static ConstantUtf8 getCachedInstance(final String value) Gets a new or cached instance of the given value. See `ConstantUtf8` class Javadoc for details. Parameters value:String the value. Returns:ConstantUtf8 a new or cached instance of the given value. Since 6.0

public static ConstantUtf8 getCachedInstance(final String value)

Gets a new or cached instance of the given value.

See ConstantUtf8 class Javadoc for details.

Parameters

value:String: the value.

Returns:ConstantUtf8

a new or cached instance of the given value.

Since

6.0

getInstance back to summary

getInstance	back to summary
public static ConstantUtf8 getInstance(final DataInput dataInput) throws IOException Gets a new or cached instance of the given value. See `ConstantUtf8` class Javadoc for details. Parameters dataInput:DataInput the value. Returns:ConstantUtf8 a new or cached instance of the given value. Exceptions IOException: if an I/O error occurs. Since 6.0

public static ConstantUtf8 getInstance(final DataInput dataInput) throws IOException

Gets a new or cached instance of the given value.

See ConstantUtf8 class Javadoc for details.

Parameters

dataInput:DataInput: the value.

Returns:ConstantUtf8

a new or cached instance of the given value.

Exceptions

IOException:: if an I/O error occurs.

Since

6.0

getInstance back to summary

getInstance	back to summary
public static ConstantUtf8 getInstance(final String value) Gets a new or cached instance of the given value. See `ConstantUtf8` class Javadoc for details. Parameters value:String the value. Returns:ConstantUtf8 a new or cached instance of the given value. Since 6.0

public static ConstantUtf8 getInstance(final String value)

Gets a new or cached instance of the given value.

See ConstantUtf8 class Javadoc for details.

Parameters

value:String: the value.

Returns:ConstantUtf8

a new or cached instance of the given value.

Since

6.0

printStats	back to summary
pack-priv static void printStats()

setBytes	back to summary
public void setBytes(final String bytes) Deprecated (since 6.0) Parameters bytes:String the raw bytes of this UTF-8 Annotations @Deprecated

toString	back to summary
public String toString() Overrides org.apache.bcel.classfile.Constant.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String String representation Annotations @Override

toString

back to summary

public String toString()

Overrides org.apache.bcel.classfile.Constant.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

String representation

Annotations

@Override

org.apache.bcel.classfile back to summary

private final Class ConstantUtf8.Cache

Class Inheritance

extends Object

java.lang.Object
org.apache.bcel.classfile.ConstantUtf8.Cache

Field Summary

Modifier and Type	Field and Description
private static final boolean	BCEL_STATISTICS
private static final HashMap<String, ConstantUtf8>	CACHE
private static final int	INITIAL_CAPACITY
private static final int	MAX_ENTRIES
private static final int	MAX_ENTRY_SIZE

Constructor Summary

Access	Constructor and Description
private	Cache()

Method Summary

Modifier and Type	Method and Description
pack-priv static boolean	isEnabled()

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

Field Detail

BCEL_STATISTICS	back to summary
private static final boolean BCEL_STATISTICS

CACHE	back to summary
private static final HashMap<String, ConstantUtf8> CACHE

INITIAL_CAPACITY	back to summary
private static final int INITIAL_CAPACITY

MAX_ENTRIES	back to summary
private static final int MAX_ENTRIES

MAX_ENTRY_SIZE	back to summary
private static final int MAX_ENTRY_SIZE

Constructor Detail

Cache	back to summary
private Cache()

Method Detail

isEnabled	back to summary
pack-priv static boolean isEnabled()

public final Class ConstantUtf8

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class ConstantUtf8.Cache

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail