public abstract class BasicScope extends Object implements IBasicScope
Modifier and Type | Field and Description |
---|---|
protected int |
keepDelay
Set to amount of time (in seconds) the scope will be kept before being freed,
after the last disconnect.
|
protected boolean |
keepOnDisconnect
Set to true to prevent the scope from being freed upon disconnect.
|
protected Set<IEventListener> |
listeners
List of event listeners
|
protected String |
name
String identifier for this scope
|
protected IScope |
parent
Parent scope.
|
protected String |
persistenceClass
Scope persistence storage type
|
protected boolean |
persistent
Whether or not to persist attributes
|
protected IPersistenceStore |
store
Storage for persistable attributes
|
protected ScopeType |
type
Scope type.
|
Constructor and Description |
---|
BasicScope()
Creates unnamed scope
|
BasicScope(IScope parent,
ScopeType type,
String name,
boolean persistent)
Constructor for basic scope
|
Modifier and Type | Method and Description |
---|---|
void |
addEventListener(IEventListener listener)
Add event listener to list of notified objects
|
void |
dispatchEvent(IEvent event)
Dispatches event (notifies all listeners)
|
boolean |
equals(Object obj)
Equality is based on the scope's name and type
|
int |
getDepth()
Get the scopes depth, how far down the scope tree is it.
|
Set<IEventListener> |
getEventListeners()
Return listeners list iterator
|
String |
getName()
Get the name of this scope.
|
IScope |
getParent()
Get this scopes parent.
|
String |
getPath()
Get the full absolute path.
|
IPersistenceStore |
getStore()
Get the persistable store
|
ScopeType |
getType()
Get the type of the scope.
|
boolean |
handleEvent(IEvent event)
Handles event.
|
boolean |
hasEventListeners()
Returns true if there are event listeners attached to
this scope.
|
int |
hashCode()
Hash code is based on the scope's name and type
|
boolean |
hasParent()
Does this scope have a parent? You can think of scopes as of tree items
where scope may have a parent and children (child).
|
boolean |
isValid()
Validates a scope based on its name and type
|
void |
notifyEvent(IEvent event)
Notifies listeners on event.
|
void |
removeEventListener(IEventListener listener)
Remove event listener from list of listeners
|
void |
setKeepDelay(int keepDelay)
Sets the amount of time to keep the scope available after the
last disconnect.
|
protected String name
protected boolean persistent
protected IPersistenceStore store
protected String persistenceClass
protected boolean keepOnDisconnect
protected int keepDelay
protected Set<IEventListener> listeners
@ConstructorProperties(value="") public BasicScope()
@ConstructorProperties(value={"parent","type","name","persistent"}) public BasicScope(IScope parent, ScopeType type, String name, boolean persistent)
parent
- Parent scopetype
- Scope typename
- Scope name. Used to identify scopes in application, must be unique among scopes of one levelpersistent
- Whether scope is persistentpublic boolean hasParent()
hasParent
in interface IBasicScope
true
if this scope has a parent, otherwise
false
public IScope getParent()
getParent
in interface IBasicScope
null
if this scope doesn't have a
parentpublic ScopeType getType()
IBasicScope
getType
in interface IBasicScope
public String getName()
IBasicScope
someroom
.getName
in interface IBasicScope
public IPersistenceStore getStore()
IBasicScope
getStore
in interface IBasicScope
public int getDepth()
getDepth
in interface IBasicScope
public String getPath()
host/myapp/someroom
.getPath
in interface IBasicScope
public void setKeepDelay(int keepDelay)
setKeepDelay
in interface IBasicScope
keepDelay
- delaypublic boolean isValid()
isValid
in interface IBasicScope
public void addEventListener(IEventListener listener)
addEventListener
in interface IEventObservable
listener
- Listening objectpublic void removeEventListener(IEventListener listener)
removeEventListener
in interface IEventObservable
listener
- Listener to removepublic Set<IEventListener> getEventListeners()
getEventListeners
in interface IEventObservable
public boolean hasEventListeners()
public boolean handleEvent(IEvent event)
handleEvent
in interface IEventHandler
event
- Event contextpublic void notifyEvent(IEvent event)
notifyEvent
in interface IEventListener
event
- Event to broadcastpublic void dispatchEvent(IEvent event)
dispatchEvent
in interface IEventDispatcher
event
- Event to dispatchpublic int hashCode()
Copyright © 2006-2012 The Red5 Project