juce::StringPool Class Reference

A StringPool holds a set of shared strings, which reduces storage overheads and improves comparison speed when dealing with many duplicate strings. More...

#include <juce_StringPool.h>

Collaboration diagram for juce::StringPool:

Public Member Functions
	StringPool () noexcept
	Creates an empty pool. More...
void	garbageCollect ()
	Scans the pool, and removes any strings that are unreferenced. More...
String	getPooledString (const char *original)
	Returns a pointer to a copy of the string that is passed in. More...
String	getPooledString (const String &original)
	Returns a pointer to a shared copy of the string that is passed in. More...
String	getPooledString (String::CharPointerType start, String::CharPointerType end)
	Returns a pointer to a copy of the string that is passed in. More...
String	getPooledString (StringRef original)
	Returns a pointer to a shared copy of the string that is passed in. More...

Static Public Member Functions
static StringPool &	getGlobalPool () noexcept
	Returns a shared global pool which is used for things like Identifiers, XML parsing. More...

Private Member Functions
void	garbageCollectIfNeeded ()

Private Attributes
uint32	lastGarbageCollectionTime
CriticalSection	lock
Array< String >	strings

Detailed Description

A StringPool holds a set of shared strings, which reduces storage overheads and improves comparison speed when dealing with many duplicate strings.

When you add a string to a pool using getPooledString, it'll return a character array containing the same string. This array is owned by the pool, and the same array is returned every time a matching string is asked for. This means that it's trivial to compare two pooled strings for equality, as you can simply compare their pointers. It also cuts down on storage if you're using many copies of the same string.

@tags{Core}

Constructor & Destructor Documentation

StringPool()

juce::StringPool::StringPool ( )

noexcept

Creates an empty pool.

Member Function Documentation

garbageCollect()

void juce::StringPool::garbageCollect

(

)

Scans the pool, and removes any strings that are unreferenced.

You don't generally need to call this - it'll be called automatically when the pool grows large enough to warrant it.

garbageCollectIfNeeded()

void juce::StringPool::garbageCollectIfNeeded ( )

private

getGlobalPool()

static StringPool& juce::StringPool::getGlobalPool ( )

staticnoexcept

Returns a shared global pool which is used for things like Identifiers, XML parsing.

getPooledString() [1/4]

String juce::StringPool::getPooledString

(

const char *

original

)

Returns a pointer to a copy of the string that is passed in.

The pool will always return the same String object when asked for a string that matches it.

getPooledString() [2/4]

String juce::StringPool::getPooledString

(

const String &

original

)

Returns a pointer to a shared copy of the string that is passed in.

The pool will always return the same String object when asked for a string that matches it.

getPooledString() [3/4]

String juce::StringPool::getPooledString	(	String::CharPointerType	start,
		String::CharPointerType	end
	)

Returns a pointer to a copy of the string that is passed in.

The pool will always return the same String object when asked for a string that matches it.

getPooledString() [4/4]

String juce::StringPool::getPooledString

(

StringRef

original

)

Returns a pointer to a shared copy of the string that is passed in.

The pool will always return the same String object when asked for a string that matches it.

Member Data Documentation

lastGarbageCollectionTime

uint32 juce::StringPool::lastGarbageCollectionTime

private

lock

CriticalSection juce::StringPool::lock

private

strings

Array<String> juce::StringPool::strings

private

---

The documentation for this class was generated from the following file:

• juce_StringPool.h