public interface Context extends Component
Modifier and Type | Interface and Description |
---|---|
static class |
Context.NO_VALUE |
Modifier and Type | Field and Description |
---|---|
static java.lang.Object |
NO_VALUE
The NO_VALUE object is returned by
getValue
if no value corresponds to the provided name. |
Modifier and Type | Method and Description |
---|---|
void |
acquire()
Acquires the target context.
|
Element |
addElement(Name name,
java.lang.Class type,
int value)
Adds an element to the target context.
|
Element |
addElement(Name name,
java.lang.Class type,
java.lang.Object value)
Adds an element in the target context.
|
Element |
addElement(Name name,
Component component)
Adds an element in the target context.
|
Element |
addElement(java.lang.String name,
java.lang.Class type,
int value,
char separator)
Adds an element to the target context.
|
Element |
addElement(java.lang.String name,
java.lang.Class type,
java.lang.Object value,
char separator)
Adds an element to the target context.
|
Element |
addElement(java.lang.String name,
Component component,
char separator)
Adds an element to the target context.
|
Context |
addOrGetContext(Name _name) |
Context |
addOrGetContext(java.lang.String _name,
char _separator) |
Component |
getComponent(java.lang.String name,
char separator)
Returns the component contained in the element registered in the target context under
the name
name . |
Element |
getElement(java.lang.String name,
char separator)
Returns the element in the target context identified by
name ,
null if no element is registered under name name . |
java.util.Enumeration |
getElements()
Returns an enumeration of the elements found in the target context.
|
int |
getIntValue(Name name)
Returns the value of the element registered in the target context under
the name
name . |
int |
getIntValue(java.lang.String name,
char separator)
Returns the value of the element registered in the target context under
the name
name . |
Context |
getScope()
Returns the scope of the target context;
|
java.lang.Object |
getValue(java.lang.String name,
char separator)
Returns the value of the element registered in the target context under
the name
name . |
void |
release()
Releases the target context, releasing all the resources it uses, if no one still
uses it.
|
void |
reset()
Resets the target context, removing all its current elements.
|
Context |
setScope(Context scope)
Sets the scope of the target context;
|
fork, getComponent, getElement, getFactoryValue, getIntValue, getReference, getType, getValue, getValue, setReference
static final java.lang.Object NO_VALUE
getValue
if no value corresponds to the provided name.Element addElement(Name name, java.lang.Class type, java.lang.Object value) throws JonathanException
name
- the name of the object to be added;type
- the type of the object to be added;value
- the object to be added.JonathanException
- if something goes wrong (usually, a type
exception).Element addElement(Name name, java.lang.Class type, int value) throws JonathanException
Class
is one of int.class, short.class, char.class,
or byte.class.name
- the name of the element to be added;value
- the integer value of the element to be added;JonathanException
- if something goes wrong (usually, a type
exception).Element addElement(Name name, Component component) throws JonathanException
name
- the name of the element to be added;component
- the component to be added;JonathanException
- if something goes wrong (usually, a type
exception).Element addElement(java.lang.String name, java.lang.Class type, java.lang.Object value, char separator) throws JonathanException
addElement(Name,Class,Object)
, except that the name to use
is specified by a string and a separator separating the different elements of
the name.
If separator == 0
, the name corresponds to an object
local to the target context.
If the name begins with the separator, the name is an absolute name (this
only makes sense if the context has a tree structure); otherwise, the name is
relative to the target context.name
- a string representing the name of the seeked element;type
- the type of the object to be added;value
- the object to be added;separator
- the separator character used to parse name
;JonathanException
- if something goes wrong (usually, a type
exception).Element addElement(java.lang.String name, Component component, char separator) throws JonathanException
addElement(Name,Component)
, except that the name to use
is specified by a string and a separator separating the different elements of
the name.
If separator == 0
, the name corresponds to an object
local to the target context.
If the name begins with the separator, the name is an absolute name (this
only makes sense if the context has a tree structure); otherwise, the name is
relative to the target context.name
- a string representing the name of the added element;component
- the component to be added;separator
- the separator character used to parse name
;JonathanException
- if something goes wrong (usually, a type
exception).Element addElement(java.lang.String name, java.lang.Class type, int value, char separator) throws JonathanException
addElement(Name,Class,int)
, except that the name to use
is specified by a string and a separator separating the different elements of
the name.
If separator == 0
, the name corresponds to an object
local to the target context.
If the name begins with the separator, the name is an absolute name (this
only makes sense if the context has a tree structure); otherwise, the name is
relative to the target context.name
- a string representing the name of the seeked element;value
- the integer value of the element to be added;separator
- the separator character used to parse name
;JonathanException
- if something goes wrong (usually, a type
exception).Context addOrGetContext(java.lang.String _name, char _separator) throws JonathanException
JonathanException
Context addOrGetContext(Name _name) throws JonathanException
JonathanException
Element getElement(java.lang.String name, char separator)
name
,
null if no element is registered under name name
.
This method is equivalent to getElement(Name)
, except that the name to use
is specified by a string and a separator separating the different elements of
the name.
If separator == 0
, the name corresponds to an object
local to the target context.
If the name begins with the separator, the name is an absolute name (this
only makes sense if the context has a tree structure); otherwise, the name is
relative to the target context.name
- a string representing the name of the seeked element;separator
- the separator character used to parse name
;Component getComponent(java.lang.String name, char separator)
name
.
This method is equivalent to getComponent(Name)
, except that the name to use
is specified by a string and a separator separating the different elements of
the name.
If separator == 0
, the name corresponds to an object
local to the target context.
If the name begins with the separator, the name is an absolute name (this
only makes sense if the context has a tree structure); otherwise, the name is
relative to the target context.name
- the name of the element whose component is seeked;separator
- the separator character used to parse name
;java.lang.Object getValue(java.lang.String name, char separator)
name
.
This method is equivalent to getValue(Name)
, except that the name to use
is specified by a string and a separator separating the different elements of
the name.
If separator == 0
, the name corresponds to an object
local to the target context.
If the name begins with the separator, the name is an absolute name (this
only makes sense if the context has a tree structure); otherwise, the name is
relative to the target context.name
- the name of the element whose value is seeked;separator
- the separator character used to parse name
;NO_VALUE
.int getIntValue(Name name)
name
.
A call to getIntValue(name)
is equivalent to
if the provided name actually corresponds to an
element. If it is not the case,
getElement(name)
.getIntValue()
Integer.MAX_VALUE
is returned.
name
- the name of the element whose value is seeked;Integer.MAX_VALUE
int getIntValue(java.lang.String name, char separator)
name
.
This method is equivalent to getIntValue(Name)
, except that the name to use
is specified by a string and a separator separating the different elements of
the name.
If separator == 0
, the name corresponds to an object
local to the target context.
If the name begins with the separator, the name is an absolute name (this
only makes sense if the context has a tree structure); otherwise, the name is
relative to the target context.name
- the name of the element whose value is seeked;separator
- the separator character used to parse name
;Integer.MAX_VALUE
java.util.Enumeration getElements()
void release()
void acquire()
void reset()
Context setScope(Context scope)
scope
- the new scope of the target context;Context getScope()