Package org.dwcj.environment.namespace

Class StandardNamespace

java.lang.Object

org.dwcj.environment.namespace.StandardNamespace

All Implemented Interfaces:

CanLock, Namespace

Direct Known Subclasses:

GlobalNamespace, GroupNamespace, PrivateNamespace

public abstract class StandardNamespace
extends Object
implements Namespace, CanLock

A Namespace is a shared object space, like a singleton. Depending on its type it's shared gloablly across all clients, a family of clients started by the same parent, or has a private name.

Nested Class Summary

Nested classes/interfaces inherited from interface org.dwcj.environment.namespace.Namespace

Namespace.NamespaceType

Field Summary

Fields

Modifier and Type	Field	Description
protected com.basis.bbj.proxies.BBjNamespace	ns

Constructor Summary

Constructors

Constructor	Description
StandardNamespace()

Method Summary

Modifier and Type	Method	Description
void	clear()	Delete all variables in this namespace
Object	get(String key)	retrieve a variable from the namespace
Set<String>	keySet()	list all variables in this namespace
StandardNamespace	onAccess(Consumer<NamespaceEvent> consumer)	Register a callback that is called whenever anything inside this namespace is being written, regardless if it was a change
StandardNamespace	onChange(Consumer<NamespaceEvent> consumer)	Register a callback that is called whenever anything inside this namespace changes
StandardNamespace	onVariableAccess(String key, Consumer<NamespaceEvent> consumer)	Register a callback that is called whenever a specific variable inside this namespace was written, regardless if it changed its value
StandardNamespace	onVariableChange(String key, Consumer<NamespaceEvent> consumer)	Register a callback that is called whenever a specific variable inside this namespace changes
void	put(String key, Object value)	Put a variable in the namespace
void	remove(String key)	remove a variable from the namespace
void	removeLock(String key)
void	setLock(String key, long timeout)
int	size()	Get the variable count in this namespace.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ns

protected com.basis.bbj.proxies.BBjNamespace ns

Constructor Details

StandardNamespace

public StandardNamespace()

Method Details

put

public void put(String key,
 Object value)
         throws NamespaceVarableLockedException

Description copied from interface: Namespace

Put a variable in the namespace

Specified by:

put in interface Namespace

Parameters:

key - the variable name

value - the variable contents

Throws:

NamespaceVarableLockedException

get

public Object get(String key)

Description copied from interface: Namespace

retrieve a variable from the namespace

Specified by:

get in interface Namespace

Parameters:

key - the variable name

Returns:

the variable content

remove

public void remove(String key)
            throws NamespaceVarableLockedException

Description copied from interface: Namespace

remove a variable from the namespace

Specified by:

remove in interface Namespace

Parameters:

key - the variable name

Throws:

NamespaceVarableLockedException

keySet

public Set<String> keySet()

Description copied from interface: Namespace

list all variables in this namespace

Specified by:

keySet in interface Namespace

Returns:

a Set with all the names

size

public int size()

Description copied from interface: Namespace

Get the variable count in this namespace.

Specified by:

size in interface Namespace

Returns:

the count of variables / objects

clear

public void clear()

Description copied from interface: Namespace

Delete all variables in this namespace

Specified by:

clear in interface Namespace

setLock

public void setLock(String key,
 long timeout)
             throws NamespaceVarableLockedException

Specified by:

setLock in interface CanLock

Throws:

NamespaceVarableLockedException

removeLock

public void removeLock(String key)

Specified by:

removeLock in interface CanLock

onChange

public StandardNamespace onChange(Consumer<NamespaceEvent> consumer)

Register a callback that is called whenever anything inside this namespace changes

Parameters:

consumer - the consumer to notify

Returns:

onAccess

public StandardNamespace onAccess(Consumer<NamespaceEvent> consumer)

Register a callback that is called whenever anything inside this namespace is being written, regardless if it was a change

Parameters:

consumer - the consumer to notify

Returns:

onVariableChange

public StandardNamespace onVariableChange(String key,
 Consumer<NamespaceEvent> consumer)

Register a callback that is called whenever a specific variable inside this namespace changes

Parameters:

consumer - the consumer to notify

Returns:

onVariableAccess

public StandardNamespace onVariableAccess(String key,
 Consumer<NamespaceEvent> consumer)

Register a callback that is called whenever a specific variable inside this namespace was written, regardless if it changed its value

Parameters:

consumer - the consumer to notify

Returns: