com.neeve.lang

Interface IXStringFactory<T extends XString>

Type Parameters:

T - The type of the concrete XString or subclass

All Known Implementing Classes:

XStringFactory

public interface IXStringFactory<T extends XString>

A factory interface for creating new concrete instances of an XString

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROP_INITIAL_CAPACITY Property name used to control the initial capacity of backing storage for strings created by a factory.
static String	PROP_POOL_PREALLOCATE_COUNT Property indicating whether or not the pool backing the factory should preallocate XStrings to avoid object promotion at runtime.
static String	PROP_POOL_THREADED Property indicating whether or not the pool backing the factory is a thread safe.
static String	PROP_POOLED Property indicating whether or not the factory is backed by a pool.

Method Summary

Modifier and Type	Method and Description
T	create() Create an empty, mutable XString possibly from a backing pool.
T	create(boolean mutable) Create an empty XString possibly from a backing pool.
T	create(String value) Creates an immutable XString, possibly from a backing pool, from the given String value.
T	create(String initialValue, boolean mutable) Creates an XString possibly from a backing pool.
T	create(XString initialValue, boolean mutable) Creates an XString possibly from a backing pool.
T[]	createArray(int size) Create an array of XStrings

Field Detail

PROP_INITIAL_CAPACITY

static final String PROP_INITIAL_CAPACITY

Property name used to control the initial capacity of backing storage for strings created by a factory.

XStrings do not allocate the backing storage until a value is set in it. Subsequent changes in the XString value will dynamicaly resize the backing storage if need be. The backing storage initial capacity specifies the minimum size of the storage to allocate on the first allocation. This property should be configured if the XStrings created by this factory is expected to undergo several value changes of a variety of sizes. In such a case, this property should be set as the upper bound of the set of values expected to be set so the backing storage does not go through excesive resizing

See Also:

Constant Field Values

PROP_POOLED

static final String PROP_POOLED

Property indicating whether or not the factory is backed by a pool.

This Property applies to Factorys for XString subclasses that support pooling.

See Also:

Constant Field Values

PROP_POOL_THREADED

static final String PROP_POOL_THREADED

Property indicating whether or not the pool backing the factory is a thread safe.

This Property applies to Factorys for XString subclasses that support pooling or preallocation.

See Also:

Constant Field Values

PROP_POOL_PREALLOCATE_COUNT

static final String PROP_POOL_PREALLOCATE_COUNT

Property indicating whether or not the pool backing the factory should preallocate XStrings to avoid object promotion at runtime.

This Property only applies to Factorys for XString subclasses that support preallocation

See Also:

Constant Field Values

Method Detail

create

T create()

Create an empty, mutable XString possibly from a backing pool. When the the user is done with the XString, dispose() should be called (if the the XString is a poolable type) to return the object to the pool.

Returns:

An uninitialized XString.

createArray

T[] createArray(int size)

Create an array of XStrings

Parameters:

size - the size of the array to create

Returns:

A mutable array of uninitialized strings.

create

T create(boolean mutable)

Create an empty XString possibly from a backing pool. When the the user is done with the XString, dispose() should be called (if the the XString is a poolable type) to return the object to the pool.

Parameters:

mutable - Whether or not the XString supports mutation (after it is first set)

Returns:

An uninitialized XString.

create

T create(String value)

Creates an immutable XString, possibly from a backing pool, from the given String value. When the the user is done with the XString, dispose() should be called (if the the XString is a poolable type) to return the object to the pool.

Parameters:

value - The string value to assign to the XString.

Returns:

An initialized XString

create

T create(String initialValue,
         boolean mutable)

Creates an XString possibly from a backing pool. When the the user is done with the XString, dispose() should be called (if the the XString is a poolable type) to return the object to the pool.

Parameters:

initialValue - The string value to assign to the XString.

mutable - Whether or not the XString supports mutation.

Returns:

An initialized XString

create

T create(XString initialValue,
         boolean mutable)

Creates an XString possibly from a backing pool. When the the user is done with the XString, dispose() should be called (if the the XString is a poolable type) to return the object to the pool.

Parameters:

initialValue - The string value to assign to the XString.

mutable - Whether or not the XString supports mutation.

Returns:

An initialized XString.