net.openhft.chronicle.engine

Enum Chassis

java.lang.Object

java.lang.Enum<Chassis>

net.openhft.chronicle.engine.Chassis

All Implemented Interfaces:

Serializable, Comparable<Chassis>

public enum Chassis
extends Enum<Chassis>

This class is the starting point for a simple client or server configuration. It defines how to obtain some common resource types.

If you need a more complex environment or tests case you can create one or more AssetTrees directly.

Method Summary

Modifier and Type	Method and Description
static Asset	acquireAsset(String name) Get or create an empty asset
static <K,V> MapView<K,V,V>	acquireMap(String uri, Class<K> kClass, Class<V> vClass) Get or create a Map, ConcurrentMap or MapView of an asset.
static <E> Publisher<E>	acquirePublisher(String uri, Class<E> eClass) Get or create a Publisher view for a given lement or update type.
static <E> Reference<E>	acquireReference(String uri, Class<E> eClass) Obtain a reference to an element or value of Map.
static <E> Set<E>	acquireSet(String uri, Class<E> eClass) View an asset as a set.
static <T,E> TopicPublisher<T,E>	acquireTopicPublisher(String uri, Class<T> tClass, Class<E> eClass) Get or create a TopicPublisher.
static AssetTree	assetTree()
static void	close() Shutdown everything in the asset tree.
static Asset	getAsset(String uri) Get an existing Asset or return null
static <E> void	registerSubscriber(String uri, Class<E> eClass, Subscriber<E> subscriber) Register a Subscriber to events on an Asset.
static <T,E> void	registerTopicSubscriber(String uri, Class<T> tClass, Class<E> eClass, TopicSubscriber<T,E> subscriber) Register a Topic Subscription to a group.
static void	resetChassis() Replace the underlying
static <E> void	unregisterSubscriber(String uri, Subscriber<E> subscriber) Unregister a subscriber.
static <T,E> void	unregisterTopicSubscriber(String uri, TopicSubscriber<T,E> subscriber) Unregister a TopicSubscriber.
static Chassis	valueOf(String name) Returns the enum constant of this type with the specified name.
static Chassis[]	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

Method Detail

values

public static Chassis[] 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 (Chassis c : Chassis.values())
    System.out.println(c);

Returns:

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

valueOf

public static Chassis 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

resetChassis

public static void resetChassis()

Replace the underlying

assetTree

public static AssetTree assetTree()

Returns:

Obtain the current AssetTree used by default.

acquireSet

@NotNull
public static <E> Set<E> acquireSet(@NotNull
                                             String uri,
                                             Class<E> eClass)
                                      throws AssetNotFoundException

View an asset as a set.

Parameters:

uri - of the set

eClass - of the elements of the set

Returns:

the set view.

Throws:

AssetNotFoundException - if not found or could not be created.

acquireMap

@NotNull
public static <K,V> MapView<K,V,V> acquireMap(@NotNull
                                                       String uri,
                                                       Class<K> kClass,
                                                       Class<V> vClass)
                                                throws AssetNotFoundException

Get or create a Map, ConcurrentMap or MapView of an asset.

Parameters:

uri - of the Map.

kClass - key class

vClass - value class

Returns:

the Map

Throws:

AssetNotFoundException - if not found or could not be created.

acquireReference

@NotNull
public static <E> Reference<E> acquireReference(@NotNull
                                                         String uri,
                                                         Class<E> eClass)
                                                  throws AssetNotFoundException

Obtain a reference to an element or value of Map. Once this has been obtained you can perform a number of operation on this specific value would looking it up again.

Parameters:

uri - of the resource

eClass - the type of the element

Returns:

a view to a resource.

Throws:

AssetNotFoundException - if not found or could not be created.

acquirePublisher

@NotNull
public static <E> Publisher<E> acquirePublisher(@NotNull
                                                         String uri,
                                                         Class<E> eClass)
                                                  throws AssetNotFoundException

Get or create a Publisher view for a given lement or update type.

Parameters:

uri - to publish to.

eClass - of the data to publish

Returns:

a Publisher for this uri

Throws:

AssetNotFoundException - if not found or could not be created.

acquireTopicPublisher

@NotNull
public static <T,E> TopicPublisher<T,E> acquireTopicPublisher(@NotNull
                                                                       String uri,
                                                                       Class<T> tClass,
                                                                       Class<E> eClass)
                                                                throws AssetNotFoundException

Get or create a TopicPublisher. A Topic Publisher can specify the topic to publish to.

Parameters:

uri - of the group to publish to. When you specify a tipuc, in will be immediately under that group.

tClass - class of the topic. Typically String.class

eClass - class of the messages to publish on that topic.

Returns:

a TopicPublisher for the group uri.

Throws:

AssetNotFoundException - if not found or could not be created.

registerSubscriber

public static <E> void registerSubscriber(@NotNull
                                          String uri,
                                          Class<E> eClass,
                                          Subscriber<E> subscriber)
                                   throws AssetNotFoundException

Register a Subscriber to events on an Asset. The rule of the AssetTree might allow different behaviour depending on the eClass subscribed to. e.g. if you subscribe to MapEvent you may get MapEvent updates, however, if you subscribe to the key type you may get just the keys which changed.

Parameters:

uri - of the asset to subscribe to event for.

eClass - of the subscription

subscriber - to listen to events.

Throws:

AssetNotFoundException - if not found or could not be created.

unregisterSubscriber

public static <E> void unregisterSubscriber(@NotNull
                                            String uri,
                                            Subscriber<E> subscriber)

Unregister a subscriber. Note: the subscriber must be equals() to the subscriber registered otherwise this will silently fail. e.g. two lambdas which capture the same object are never equals()

Parameters:

uri - of the asset to unsubscribe from.

subscriber - to unregister

registerTopicSubscriber

public static <T,E> void registerTopicSubscriber(@NotNull
                                                 String uri,
                                                 Class<T> tClass,
                                                 Class<E> eClass,
                                                 TopicSubscriber<T,E> subscriber)
                                          throws AssetNotFoundException

Register a Topic Subscription to a group. This subscriber will be give the topic and the message for each event.

Parameters:

uri - of the group of Assets to listen to.

tClass - topic class

eClass - element class for messages.

subscriber - to listen to events on

Throws:

AssetNotFoundException - if not found or could not be created.

unregisterTopicSubscriber

public static <T,E> void unregisterTopicSubscriber(@NotNull
                                                   String uri,
                                                   TopicSubscriber<T,E> subscriber)

Unregister a TopicSubscriber. Note: the subscriber must be equals() to the subscriber registered otherwise this will silently fail. e.g. two lambdas which capture the same object are never equals()

Parameters:

uri - of the group of Assets to unregister from

subscriber - to remove.

acquireAsset

public static Asset acquireAsset(String name)
                          throws AssetNotFoundException

Get or create an empty asset

Parameters:

name - of the asset

Returns:

the Asset

Throws:

AssetNotFoundException - if not found or could not be created.

getAsset

@Nullable
public static Asset getAsset(String uri)

Get an existing Asset or return null

Parameters:

uri - of the asset

Returns:

the Asset or null if not found

close

public static void close()

Shutdown everything in the asset tree.