java.lang.Object
- net.officefloor.frame.impl.construct.managedobjectsource.ManagedObjectBuilderImpl<O,F,MS>

All Implemented Interfaces:: ManagedObjectBuilder<F>, ManagedObjectSourceConfiguration<F,MS>

public class ManagedObjectBuilderImpl<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>,MS extends ManagedObjectSource<O,F>>
extends java.lang.Object
implements ManagedObjectBuilder<F>, ManagedObjectSourceConfiguration<F,MS>

Implements the ManagedObjectBuilder.

Author:: Daniel Sagenschneider

Constructor Summary

Constructors
Constructor	Description
`ManagedObjectBuilderImpl(java.lang.String managedObjectSourceName, java.lang.Class<MS> managedObjectSourceClass)`	Initiate.
`ManagedObjectBuilderImpl(java.lang.String managedObjectSourceName, MS managedObjectSource)`	Initiate.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addAdditionalProfile(java.lang.String profile)`	Adds an additional profile.
`void`	`addProperty(java.lang.String name, java.lang.String value)`	Specifies a property for the `ManagedObjectSource`.
`java.lang.String[]`	`getAdditionalProfiles()`	Obtains the additional profiles.
`ManagedObjectPoolConfiguration`	`getManagedObjectPoolConfiguration()`	Obtains the `ManagedObjectPoolConfiguration` for this `ManagedObjectSource`.
`MS`	`getManagedObjectSource()`	Obtains the `ManagedObjectSource` instance to use.
`java.lang.Class<MS>`	`getManagedObjectSourceClass()`	Obtains the `Class` of the `ManagedObjectSource`.
`java.lang.String`	`getManagedObjectSourceName()`	Obtains the name of this `ManagedObjectSource`.
`ManagingOfficeConfiguration<F>`	`getManagingOfficeConfiguration()`	Obtains the `ManagingOfficeConfiguration` detailing the `Office` responsible for managing this `ManagedObjectSource`.
`SourceProperties`	`getProperties()`	Obtains the `SourceProperties` to initialise the `ManagedObjectSource`.
`long`	`getTimeout()`	Obtains the timeout to: to source the `ManagedObject` have asynchronous operations on the `ManagedObject` complete
`ManagedObjectPoolBuilder`	`setManagedObjectPool(ManagedObjectPoolFactory managedObjectPoolFactory)`	Specifies the `ManagedObjectPoolFactory` for this `ManagedObject`.
`ManagingOfficeBuilder<F>`	`setManagingOffice(java.lang.String officeName)`	Specifies the `Office` to manage this `ManagedObject`.
`void`	`setTimeout(long timeout)`	Specifies the timeout to: to source the `ManagedObject` have asynchronous operations on the `ManagedObject` complete

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ManagedObjectBuilderImpl
```
public ManagedObjectBuilderImpl(java.lang.String managedObjectSourceName,
                                java.lang.Class<MS> managedObjectSourceClass)
```
    Initiate.
    
    Parameters:
    
    managedObjectSourceName - Name of the ManagedObjectSource.
    
    managedObjectSourceClass - Class of the ManagedObjectSource.
  - ManagedObjectBuilderImpl
```
public ManagedObjectBuilderImpl(java.lang.String managedObjectSourceName,
                                MS managedObjectSource)
```
    Initiate.
    
    Parameters:
    
    managedObjectSourceName - Name of the ManagedObjectSource.
    
    managedObjectSource - ManagedObjectSource instance to use.
- Method Detail
  - addAdditionalProfile
```
public void addAdditionalProfile(java.lang.String profile)
```
    Description copied from interface: ManagedObjectBuilder
    
    Adds an additional profile.
    
    Specified by:
    
    addAdditionalProfile in interface ManagedObjectBuilder<O extends java.lang.Enum<O>>
    
    Parameters:
    
    profile - Additional profile.
  - addProperty
```
public void addProperty(java.lang.String name,
                        java.lang.String value)
```
    Description copied from interface: ManagedObjectBuilder
    
    Specifies a property for the ManagedObjectSource.
    
    Specified by:
    
    addProperty in interface ManagedObjectBuilder<O extends java.lang.Enum<O>>
    
    Parameters:
    
    name - Name of property.
    
    value - Value of property.
  - setManagedObjectPool
```
public ManagedObjectPoolBuilder setManagedObjectPool(ManagedObjectPoolFactory managedObjectPoolFactory)
```
    Description copied from interface: ManagedObjectBuilder
    
    Specifies the ManagedObjectPoolFactory for this ManagedObject.
    
    Specified by:
    
    setManagedObjectPool in interface ManagedObjectBuilder<O extends java.lang.Enum<O>>
    
    Parameters:
    
    managedObjectPoolFactory - ManagedObjectPoolFactory for this ManagedObject.
    
    Returns:
    
    ManagedObjectPoolBuilder.
  - setTimeout
```
public void setTimeout(long timeout)
```
    Description copied from interface: ManagedObjectBuilder
    Specifies the timeout to:
    
    to source the ManagedObject
    
    have asynchronous operations on the ManagedObject complete
    Specified by:
    
    setTimeout in interface ManagedObjectBuilder<O extends java.lang.Enum<O>>
    
    Parameters:
    
    timeout - Timeout.
  - setManagingOffice
```
public ManagingOfficeBuilder<F> setManagingOffice(java.lang.String officeName)
```
    Description copied from interface: ManagedObjectBuilder
    
    Specifies the Office to manage this ManagedObject.
    
    Specified by:
    
    setManagingOffice in interface ManagedObjectBuilder<O extends java.lang.Enum<O>>
    
    Parameters:
    
    officeName - Name of the Office.
    
    Returns:
    
    ManagingOfficeBuilder.
  - getManagedObjectSourceName
```
public java.lang.String getManagedObjectSourceName()
```
    Description copied from interface: ManagedObjectSourceConfiguration
    
    Obtains the name of this ManagedObjectSource.
    
    Specified by:
    
    getManagedObjectSourceName in interface ManagedObjectSourceConfiguration<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>
    
    Returns:
    
    Name of this ManagedObjectSource.
  - getManagingOfficeConfiguration
```
public ManagingOfficeConfiguration<F> getManagingOfficeConfiguration()
```
    Description copied from interface: ManagedObjectSourceConfiguration
    
    Obtains the ManagingOfficeConfiguration detailing the Office responsible for managing this ManagedObjectSource.
    
    Specified by:
    
    getManagingOfficeConfiguration in interface ManagedObjectSourceConfiguration<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>
    
    Returns:
    
    ManagingOfficeConfiguration.
  - getManagedObjectSource
```
public MS getManagedObjectSource()
```
    Description copied from interface: ManagedObjectSourceConfiguration
    
    Obtains the ManagedObjectSource instance to use.
    
    Specified by:
    
    getManagedObjectSource in interface ManagedObjectSourceConfiguration<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>
    
    Returns:
    
    ManagedObjectSource instance to use. This may be null and therefore the ManagedObjectSourceConfiguration.getManagedObjectSourceClass() should be used to obtain the ManagedObjectSource.
  - getManagedObjectSourceClass
```
public java.lang.Class<MS> getManagedObjectSourceClass()
```
    Description copied from interface: ManagedObjectSourceConfiguration
    
    Obtains the Class of the ManagedObjectSource.
    
    Specified by:
    
    getManagedObjectSourceClass in interface ManagedObjectSourceConfiguration<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>
    
    Returns:
    
    Class of the ManagedObjectSource. Will be null if a ManagedObjectSource instance is configured.
  - getAdditionalProfiles
```
public java.lang.String[] getAdditionalProfiles()
```
    Description copied from interface: ManagedObjectSourceConfiguration
    
    Obtains the additional profiles.
    
    Specified by:
    
    getAdditionalProfiles in interface ManagedObjectSourceConfiguration<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>
    
    Returns:
    
    Additional profiles.
  - getProperties
```
public SourceProperties getProperties()
```
    Description copied from interface: ManagedObjectSourceConfiguration
    
    Obtains the SourceProperties to initialise the ManagedObjectSource.
    
    Specified by:
    
    getProperties in interface ManagedObjectSourceConfiguration<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>
    
    Returns:
    
    SourceProperties to initialise the ManagedObjectSource.
  - getManagedObjectPoolConfiguration
```
public ManagedObjectPoolConfiguration getManagedObjectPoolConfiguration()
```
    Description copied from interface: ManagedObjectSourceConfiguration
    
    Obtains the ManagedObjectPoolConfiguration for this ManagedObjectSource.
    
    Specified by:
    
    getManagedObjectPoolConfiguration in interface ManagedObjectSourceConfiguration<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>
    
    Returns:
    
    ManagedObjectPoolConfiguration for this ManagedObjectSource or null if not to be pooled.
  - getTimeout
```
public long getTimeout()
```
    Description copied from interface: ManagedObjectSourceConfiguration
    Obtains the timeout to:
    
    to source the ManagedObject
    
    have asynchronous operations on the ManagedObject complete
    Specified by:
    
    getTimeout in interface ManagedObjectSourceConfiguration<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>
    
    Returns:
    
    Timeout.

Class ManagedObjectBuilderImpl<O extends java.lang.Enum<O>,​F extends java.lang.Enum<F>,​MS extends ManagedObjectSource<O,​F>>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ManagedObjectBuilderImpl

ManagedObjectBuilderImpl

Method Detail

addAdditionalProfile

addProperty

setManagedObjectPool

setTimeout

setManagingOffice

getManagedObjectSourceName

getManagingOfficeConfiguration

getManagedObjectSource

getManagedObjectSourceClass

getAdditionalProfiles

getProperties

getManagedObjectPoolConfiguration

getTimeout

Class ManagedObjectBuilderImpl<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>,MS extends ManagedObjectSource<O,F>>