org.jomc.spi

Interface Scope

@Generated(value="org.jomc.tools.SourceFileProcessor 1.5",
           comments="See http://www.jomc.org/jomc/1.5/jomc-tools-1.5")
public interface Scope

Scope a specification applies to.

Identifier:

org.jomc.spi.Scope

Multiplicity:

Many

Scope:

None

Version:

1.0

Author:

Christian Schulte 1.0

See Also:

getObject(Scope[].class), getObject(Scope.class, "implementation name"), org.jomc.ObjectManagerFactory

Method Summary

Methods

Modifier and Type	Method and Description
Object	getObject(String identifier) Gets an object from the scope.
Map<String,Object>	getObjects() Gets the objects of the scope.
Object	putObject(String identifier, Object object) Puts an object into the scope.
Object	removeObject(String identifier) Removes an object from the scope.

Method Detail

getObjects

Map<String,Object> getObjects()

Gets the objects of the scope.

Returns:

The objects of the scope or null.

getObject

Object getObject(String identifier)
                 throws NullPointerException

Gets an object from the scope.

Parameters:

identifier - The identifier of the object to get from the scope.

Returns:

The object identified by identifier or null, if no such object exists in the scope.

Throws:

NullPointerException - if identifier is null.

putObject

Object putObject(String identifier,
               Object object)
                 throws NullPointerException

Puts an object into the scope.

Parameters:

identifier - The identifier of the object to put into the scope.

object - The object to put into the scope.

Returns:

The previous object from the scope or null, if there was no object in the scope.

Throws:

NullPointerException - if identifier or object is null.

removeObject

Object removeObject(String identifier)
                    throws NullPointerException

Removes an object from the scope.

Parameters:

identifier - The identifier of the object to remove from the scope.

Returns:

The removed object or null, if there was no object in the scope.

Throws:

NullPointerException - if identifier is null.