Index (Pip.Services Container 3.1.0 API)

A B C D F G I L M O P R S U _
All Classes and Interfaces|All Packages|Serialized Form

A

addFactory(IFactory) - Method in class org.pipservices3.container.Container: Adds a factory to the container.

B

BuildReferencesDecorator - Class in org.pipservices3.container.refer: References decorator that automatically creates missing components using available component factories upon component retrival.
BuildReferencesDecorator() - Constructor for class org.pipservices3.container.refer.BuildReferencesDecorator: Creates a new instance of the decorator.
BuildReferencesDecorator(IReferences) - Constructor for class org.pipservices3.container.refer.BuildReferencesDecorator: Creates a new instance of the decorator.
BuildReferencesDecorator(IReferences, IReferences) - Constructor for class org.pipservices3.container.refer.BuildReferencesDecorator: Creates a new instance of the decorator.

C

clarifyLocator(Object, IFactory) - Method in class org.pipservices3.container.refer.BuildReferencesDecorator: Clarifies a component locator by merging two descriptors into one to replace missing fields.
close(String) - Method in class org.pipservices3.container.Container: Closes component and frees used resources.
close(String) - Method in class org.pipservices3.container.refer.LinkReferencesDecorator: Closes component and frees used resources.
close(String) - Method in class org.pipservices3.container.refer.ManagedReferences: Closes component and frees used resources.
close(String) - Method in class org.pipservices3.container.refer.RunReferencesDecorator: Closes component and frees used resources.
ComponentConfig - Class in org.pipservices3.container.config: Configuration of a component inside a container.
ComponentConfig() - Constructor for class org.pipservices3.container.config.ComponentConfig: Creates a new instance of the component configuration.
ComponentConfig(Descriptor, TypeDescriptor, ConfigParams) - Constructor for class org.pipservices3.container.config.ComponentConfig: Creates a new instance of the component configuration.
configure(ConfigParams) - Method in class org.pipservices3.container.Container: Configures component by passing configuration parameters.
Container - Class in org.pipservices3.container: Inversion of control (IoC) container that creates components and manages their lifecycle.
Container(String, String) - Constructor for class org.pipservices3.container.Container: Creates a new instance of the container.
Container(ContainerConfig) - Constructor for class org.pipservices3.container.Container: Creates a new instance of the container.
ContainerConfig - Class in org.pipservices3.container.config: Container configuration defined as a list of component configurations.
ContainerConfig() - Constructor for class org.pipservices3.container.config.ContainerConfig: Creates a new instance of container configuration.
ContainerConfig(Collection<ComponentConfig>) - Constructor for class org.pipservices3.container.config.ContainerConfig: Creates a new instance of container configuration.
ContainerConfigReader - Class in org.pipservices3.container.config: Helper class that reads container configuration from JSON or YAML file.
ContainerConfigReader() - Constructor for class org.pipservices3.container.config.ContainerConfigReader
ContainerReferences - Class in org.pipservices3.container.refer: Container managed references that can be created from container configuration.
ContainerReferences() - Constructor for class org.pipservices3.container.refer.ContainerReferences
create(Object) - Method in class org.pipservices3.container.refer.BuildReferencesDecorator: Creates a component identified by given locator.

D

DefaultContainerFactory - Class in org.pipservices3.container.build: Creates default container components (loggers, counters, caches, locks, etc.) by their descriptors.
DefaultContainerFactory(IFactory...) - Constructor for class org.pipservices3.container.build.DefaultContainerFactory: Create a new instance of the factory and sets nested factories.
Descriptor - Static variable in class org.pipservices3.container.build.DefaultContainerFactory

F

find(Class<T>, Object, boolean) - Method in class org.pipservices3.container.refer.BuildReferencesDecorator: Gets all component references that match specified locator.
find(Class<T>, Object, boolean) - Method in class org.pipservices3.container.refer.ReferencesDecorator: Gets all component references that match specified locator.
find(Object, boolean) - Method in class org.pipservices3.container.refer.ReferencesDecorator: Gets all component references that match specified locator.
findFactory(Object) - Method in class org.pipservices3.container.refer.BuildReferencesDecorator: Finds a factory capable creating component by given descriptor from the components registered in the references.
fromConfig(ConfigParams) - Static method in class org.pipservices3.container.config.ComponentConfig: Creates a new instance of ComponentConfig based on section from container configuration.
fromConfig(ConfigParams) - Static method in class org.pipservices3.container.config.ContainerConfig: Creates a new ContainerConfig object based on configuration parameters.
fromTuples(Object...) - Static method in class org.pipservices3.container.refer.ManagedReferences: Creates a new ManagedReferences object filled with provided key-value pairs called tuples.
fromValue(Object) - Static method in class org.pipservices3.container.config.ContainerConfig: Creates a new ContainerConfig object filled with key-value pairs from specified object.

G

getAll() - Method in class org.pipservices3.container.refer.ReferencesDecorator: Gets all component references registered in this reference map.
getAllLocators() - Method in class org.pipservices3.container.refer.ReferencesDecorator: Gets locators for all registered component references in this reference map.
getConfig() - Method in class org.pipservices3.container.config.ComponentConfig
getConfig() - Method in class org.pipservices3.container.Container
getDescriptor() - Method in class org.pipservices3.container.config.ComponentConfig
getNextReferences() - Method in class org.pipservices3.container.refer.ReferencesDecorator
getOneOptional(Class<T>, Object) - Method in class org.pipservices3.container.refer.ReferencesDecorator: Gets an optional component reference that matches specified locator.
getOneOptional(Object) - Method in class org.pipservices3.container.refer.ReferencesDecorator: Gets an optional component reference that matches specified locator.
getOneRequired(Class<T>, Object) - Method in class org.pipservices3.container.refer.ReferencesDecorator: Gets a required component reference that matches specified locator.
getOneRequired(Object) - Method in class org.pipservices3.container.refer.ReferencesDecorator: Gets a required component reference that matches specified locator.
getOptional(Class<T>, Object) - Method in class org.pipservices3.container.refer.ReferencesDecorator: Gets all component references that match specified locator.
getOptional(Object) - Method in class org.pipservices3.container.refer.ReferencesDecorator: Gets all component references that match specified locator.
getReferences() - Method in class org.pipservices3.container.Container
getRequired(Class<T>, Object) - Method in class org.pipservices3.container.refer.ReferencesDecorator: Gets all component references that match specified locator.
getRequired(Object) - Method in class org.pipservices3.container.refer.ReferencesDecorator: Gets all component references that match specified locator.
getTopReferences() - Method in class org.pipservices3.container.refer.ReferencesDecorator
getType() - Method in class org.pipservices3.container.config.ComponentConfig

I

isOpen() - Method in class org.pipservices3.container.Container: Checks if the component is opened.
isOpen() - Method in class org.pipservices3.container.refer.LinkReferencesDecorator: Checks if the component is opened.
isOpen() - Method in class org.pipservices3.container.refer.ManagedReferences: Checks if the component is opened.
isOpen() - Method in class org.pipservices3.container.refer.RunReferencesDecorator: Checks if the component is opened.

L

LinkReferencesDecorator - Class in org.pipservices3.container.refer: References decorator that automatically sets references to newly added components that implement IReferenceable interface and unsets references from removed components that implement IUnreferenceable interface.
LinkReferencesDecorator() - Constructor for class org.pipservices3.container.refer.LinkReferencesDecorator: Creates a new instance of the decorator.
LinkReferencesDecorator(IReferences) - Constructor for class org.pipservices3.container.refer.LinkReferencesDecorator: Creates a new instance of the decorator.
LinkReferencesDecorator(IReferences, IReferences) - Constructor for class org.pipservices3.container.refer.LinkReferencesDecorator: Creates a new instance of the decorator.

M

ManagedReferences - Class in org.pipservices3.container.refer: Managed references that in addition to keeping and locating references can also manage their lifecycle.
ManagedReferences() - Constructor for class org.pipservices3.container.refer.ManagedReferences: Creates a new instance of the references
ManagedReferences(Object[]) - Constructor for class org.pipservices3.container.refer.ManagedReferences: Creates a new instance of the references

O

open(String) - Method in class org.pipservices3.container.Container: Opens the component.
open(String) - Method in class org.pipservices3.container.refer.LinkReferencesDecorator: Opens the component.
open(String) - Method in class org.pipservices3.container.refer.ManagedReferences: Opens the component.
open(String) - Method in class org.pipservices3.container.refer.RunReferencesDecorator: Opens the component.
org.pipservices3.container - package org.pipservices3.container
org.pipservices3.container.build - package org.pipservices3.container.build
org.pipservices3.container.config - package org.pipservices3.container.config
org.pipservices3.container.refer - package org.pipservices3.container.refer

P

ProcessContainer - Class in org.pipservices3.container: Inversion of control (IoC) container that runs as a system process.
ProcessContainer(String, String) - Constructor for class org.pipservices3.container.ProcessContainer: Creates a new instance of the container.
put(Object, Object) - Method in class org.pipservices3.container.refer.LinkReferencesDecorator: Puts a new reference into this reference map.
put(Object, Object) - Method in class org.pipservices3.container.refer.ReferencesDecorator: Puts a new reference into this reference map.
put(Object, Object) - Method in class org.pipservices3.container.refer.RunReferencesDecorator: Puts a new reference into this reference map.
putFromConfig(ContainerConfig) - Method in class org.pipservices3.container.refer.ContainerReferences: Puts components into the references from container configuration.

R

readConfigFromFile(String, String, ConfigParams) - Method in class org.pipservices3.container.Container: Reads container configuration from JSON or YAML file and parameterizes it with given values.
readFromFile(String, String, ConfigParams) - Static method in class org.pipservices3.container.config.ContainerConfigReader: Reads container configuration from JSON or YAML file.
readFromJsonFile(String, String, ConfigParams) - Static method in class org.pipservices3.container.config.ContainerConfigReader: Reads container configuration from JSON file.
readFromYamlFile(String, String, ConfigParams) - Static method in class org.pipservices3.container.config.ContainerConfigReader: Reads container configuration from YAML file.
ReferencesDecorator - Class in org.pipservices3.container.refer: Chainable decorator for IReferences that allows to inject additional capabilities such as automatic component creation, automatic registration and opening.
ReferencesDecorator() - Constructor for class org.pipservices3.container.refer.ReferencesDecorator: Creates a new instance of the decorator.
ReferencesDecorator(IReferences) - Constructor for class org.pipservices3.container.refer.ReferencesDecorator: Creates a new instance of the decorator.
ReferencesDecorator(IReferences, IReferences) - Constructor for class org.pipservices3.container.refer.ReferencesDecorator: Creates a new instance of the decorator.
remove(Object) - Method in class org.pipservices3.container.refer.LinkReferencesDecorator: Removes a previously added reference that matches specified locator.
remove(Object) - Method in class org.pipservices3.container.refer.ReferencesDecorator: Removes a previously added reference that matches specified locator.
remove(Object) - Method in class org.pipservices3.container.refer.RunReferencesDecorator: Removes a previously added reference that matches specified locator.
removeAll(Object) - Method in class org.pipservices3.container.refer.LinkReferencesDecorator: Removes all component references that match the specified locator.
removeAll(Object) - Method in class org.pipservices3.container.refer.ReferencesDecorator: Removes all component references that match the specified locator.
removeAll(Object) - Method in class org.pipservices3.container.refer.RunReferencesDecorator: Removes all component references that match the specified locator.
run(String[]) - Method in class org.pipservices3.container.ProcessContainer: Runs the container by instantiating and running components inside the container.
RunReferencesDecorator - Class in org.pipservices3.container.refer: References decorator that automatically opens to newly added components that implement IOpenable interface and closes removed components that implement IClosable interface.
RunReferencesDecorator() - Constructor for class org.pipservices3.container.refer.RunReferencesDecorator: Creates a new instance of the decorator.
RunReferencesDecorator(IReferences) - Constructor for class org.pipservices3.container.refer.RunReferencesDecorator: Creates a new instance of the decorator.
RunReferencesDecorator(IReferences, IReferences) - Constructor for class org.pipservices3.container.refer.RunReferencesDecorator: Creates a new instance of the decorator.

S

setConfig(ConfigParams) - Method in class org.pipservices3.container.config.ComponentConfig
setConfig(ContainerConfig) - Method in class org.pipservices3.container.Container
setDescriptor(Descriptor) - Method in class org.pipservices3.container.config.ComponentConfig
setNextReferences(IReferences) - Method in class org.pipservices3.container.refer.ReferencesDecorator
setReferences(IReferences) - Method in class org.pipservices3.container.Container: Sets references to dependent components.
setTopReferences(IReferences) - Method in class org.pipservices3.container.refer.ReferencesDecorator
setType(TypeDescriptor) - Method in class org.pipservices3.container.config.ComponentConfig

U

unsetReferences() - Method in class org.pipservices3.container.Container: Unsets (clears) previously set references to dependent components.

_

_builder - Variable in class org.pipservices3.container.refer.ManagedReferences
_config - Variable in class org.pipservices3.container.Container
_configPath - Variable in class org.pipservices3.container.ProcessContainer
_factories - Variable in class org.pipservices3.container.Container
_info - Variable in class org.pipservices3.container.Container
_linker - Variable in class org.pipservices3.container.refer.ManagedReferences
_logger - Variable in class org.pipservices3.container.Container
_references - Variable in class org.pipservices3.container.Container
_references - Variable in class org.pipservices3.container.refer.ManagedReferences
_runner - Variable in class org.pipservices3.container.refer.ManagedReferences

A B C D F G I L M O P R S U _
All Classes and Interfaces|All Packages|Serialized Form