fiftyone.mobile.detection

Enum DatasetBuilder.CacheTemplate

java.lang.Object

java.lang.Enum<DatasetBuilder.CacheTemplate>

fiftyone.mobile.detection.DatasetBuilder.CacheTemplate

All Implemented Interfaces:

DatasetBuilder.CacheSet, Serializable, Comparable<DatasetBuilder.CacheTemplate>

Enclosing class:

DatasetBuilder

public static enum DatasetBuilder.CacheTemplate
extends Enum<DatasetBuilder.CacheTemplate>
implements DatasetBuilder.CacheSet

Enum Constant Summary

Enum Constants

Enum Constant and Description
Default The default settings.
HighConcurrency Cache sizes optimised for a highly concurrent environment, around 100 threads and up.
MultiThread Cache sizes optimised for a multi threaded environment using a JVM limited to between 150-250 Mb.
MultiThreadLowMemory Cache sizes optimised for a multi threaded environment using a JVM limited to around 100 Mb.
SingleThread Cache sizes optimised for a single threaded environment using a JVM limited to between 150-250 Mb.
SingleThreadLowMemory Cache sizes optimised for a single threaded environment using a JVM limited to around 100 Mb.

Method Summary

Modifier and Type	Method and Description
Map<DatasetBuilder.CacheType,ICacheOptions>	getCacheConfiguration()
static DatasetBuilder.CacheTemplate	valueOf(String name) Returns the enum constant of this type with the specified name.
static DatasetBuilder.CacheTemplate[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Default

public static final DatasetBuilder.CacheTemplate Default

The default settings. Testing has shown that these settings offer all-around good performance. Suitable for most users but not optimised for any specific environment.

SingleThreadLowMemory

public static final DatasetBuilder.CacheTemplate SingleThreadLowMemory

Cache sizes optimised for a single threaded environment using a JVM limited to around 100 Mb. Memory usage without a User-Agent cache is expected to be around 60-70 Mb. Bear in mind that actual memory load is dependent on the data file type (i.e. Lite, Premium, etc) and to some extent upon the way in which the API is being used.

SingleThread

public static final DatasetBuilder.CacheTemplate SingleThread

Cache sizes optimised for a single threaded environment using a JVM limited to between 150-250 Mb. Memory usage without a User-Agent cache is expected to be around 80-90 Mb. Bear in mind that actual memory load is dependent on the data file type (i.e. Lite, Premium, etc) and to some extent upon the way in which the API is being used.

MultiThreadLowMemory

public static final DatasetBuilder.CacheTemplate MultiThreadLowMemory

Cache sizes optimised for a multi threaded environment using a JVM limited to around 100 Mb. Memory usage without a User-Agent cache is expected to be around 60-70 Mb. Bear in mind that actual memory load is dependent on the data file type (i.e. Lite, Premium, etc) and to some extent upon the way in which the API is being used.

MultiThread

public static final DatasetBuilder.CacheTemplate MultiThread

Cache sizes optimised for a multi threaded environment using a JVM limited to between 150-250 Mb. Memory usage without a User-Agent cache is expected to be around 80-90 Mb. Bear in mind that actual memory load is dependent on the data file type (i.e. Lite, Premium, etc) and to some extent upon the way in which the API is being used.

HighConcurrency

public static final DatasetBuilder.CacheTemplate HighConcurrency

Cache sizes optimised for a highly concurrent environment, around 100 threads and up. Memory usage without a User-Agent cache is expected to be around 40-120 Mb depending on the size limit imposed on the JVM. Bear in mind that actual memory load is dependent on the data file type (i.e. Lite, Premium, etc) and to some extent upon the way in which the API is being used.

Method Detail

values

public static DatasetBuilder.CacheTemplate[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DatasetBuilder.CacheTemplate c : DatasetBuilder.CacheTemplate.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DatasetBuilder.CacheTemplate valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getCacheConfiguration

public Map<DatasetBuilder.CacheType,ICacheOptions> getCacheConfiguration()

Specified by:

getCacheConfiguration in interface DatasetBuilder.CacheSet