Callable

box.system.ioc.config.concurrent.Callable interface">

Class

ColdBox Platform Version 3.1.0

FRAMES

coldbox.system.ioc.config
Class Mapping

WEB-INF.cftags.component
        coldbox.system.ioc.config.Mapping

public class Mapping
extends WEB-INF.cftags.component
extends WEB-INF.cftags.component

I model a WireBox object mapping in all of its glory and splendour

Constructor Summary

init(any name)
          Constructor

Method Summary

any addDIConstructorArgument([any name], [any ref], [any dsl], [any value], [any javaCast], [any required='true'])
          Add a new constructor argument to this mapping

any addDIMethodArgument([any name], [any ref], [any dsl], [any value], [any javaCast], [any required='true'])
          Add a new method argument to this mapping

any addDIProperty(any name, [any ref], [any dsl], [any value], [any javaCast], [any scope='variables'])
          Add a new cfproperty definition

any addDISetter(any name, [any ref], [any dsl], [any value], [any javaCast])
          Add a new DI setter definition

any addProviderMethod(any method, any mapping)
          Add a new provider method to this mapping

any<Array> getAlias()
          Get the mapping aliases array

any<struct> getCacheProperties()
          Get this mappings cache properties structure

any getConstructor()
          Get the name of the constructor method

any<array> getDIConstructorArguments()
          Get all the constructor argument definitions array

private any<coldbox.system.ioc.config.structure> getDIDefinition()
          Get a new DI definition structure

any<array> getDIMethodArguments()
          Get all the method argument definitions array

any<Array> getDIProperties()
          Get all the DI property definitions array

any<array> getDISetters()
          Get all the DI setter definitions array

any getDSL()
          Get the construction DSL

any<struct> getMemento()
          Get the instance memento structure

any getMethod()
          Get the method that this mapping needs to execute from a mapping factory

any getName()
          Get the mapping name

any getObjectMetadata()
          Get the internal mapping metadata of the object

any<array> getOnDIComplete()
          Get all the DI complete methods array

any getPath()
          Get the path to this mapping

any<Array> getProviderMethods()
          Get the discovered provider methods array

any getScope()
          Get the visibility scope

any getType()
          Get the mapping type

any getValue()
          Get the mapping value (if any)

any<Boolean> isAspect()
          Flag describing if this mapping is an AOP aspect or not

any<Boolean> isAspectAutoBinding()
          Is this mapping an auto aspect binding

any<Boolean> isAutoInit()
          Using auto init of mapping target or not as boolean

any<Boolean> isAutowire()
          Flag describing if you are using autowire or not as Boolean

any<boolean> isDSL()
          Does this mapping have a DSL construction element or not as Boolean

any<Boolean> isDiscovered()
          Checks if this mapping has already been processed or not

any<Boolean> isEagerInit()
          Is this mapping eager initialized or not as Boolean

any process(any binder, any injector, [any metadata])
          Process a mapping for metadata discovery and more

private any processAOPBinding(any binder, any metadata)
          Process the AOP self binding aspects

private void processDIMetadata(any binder, any metadata, [any dependencies='[runtime expression]'])
          Process methods/properties for dependency injection

any processMemento(any<struct> memento)
          Process a mapping memento

any setAlias(any<Array> alias)
          Set the mapping aliases

any setAspect(any<Boolean> aspect)
          Set aspect property

any setAspectAutoBinding(any<Boolean> autoBinding)
          Set the aspect auto binding bit

any setAutoInit(any autoInit)
          Set autoInit property

any setAutowire(any<Boolean> autowire)
          Set autowire property

any setCacheProperties(any key, [any timeout=''], [any lastAccessTimeout=''], [any provider='default'])
          Set the cache properties for this mapping (Needs cachebox integration)

any setConstructor(any constructor)
          Override the name of the constructor method

any setDSL(any dsl)
          Set the construction DSL

any setDiscovered()
          Flag this mapping as discovered

any setEagerInit(any eagerInit)
          Set the eager init flag

any setMethod(any method)
          Set the method used for getting this mapping from a factory

any setName(string name)
          Name the mapping

any setObjectMetadata(any metadata)
          Set the mappings CFC target metadata

any setOnDIComplete(any DIComplete)
          Set the DI Complete method array

any setPath(any path)
          Set the path to this mapping

any setScope(any scope)
          Set the visibility scope

any setType(any type)
          Set the mapping type

any setValue(any value)
          Set the mapping value

private any<Boolean> stopClassRecursion(any classname, any binder)
          Should we stop recursion or not due to class name found: Boolean

Methods inherited from class WEB-INF.cftags.component

Constructor Summary
`init(any name)` Constructor

Method Summary
`any`	`addDIConstructorArgument([any name], [any ref], [any dsl], [any value], [any javaCast], [any required='true'])` Add a new constructor argument to this mapping
`any`	`addDIMethodArgument([any name], [any ref], [any dsl], [any value], [any javaCast], [any required='true'])` Add a new method argument to this mapping
`any`	`addDIProperty(any name, [any ref], [any dsl], [any value], [any javaCast], [any scope='variables'])` Add a new cfproperty definition
`any`	`addDISetter(any name, [any ref], [any dsl], [any value], [any javaCast])` Add a new DI setter definition
`any`	`addProviderMethod(any method, any mapping)` Add a new provider method to this mapping
`any<Array>`	`getAlias()` Get the mapping aliases array
`any<struct>`	`getCacheProperties()` Get this mappings cache properties structure
`any`	`getConstructor()` Get the name of the constructor method
`any<array>`	`getDIConstructorArguments()` Get all the constructor argument definitions array
`private any<coldbox.system.ioc.config.structure>`	`getDIDefinition()` Get a new DI definition structure
`any<array>`	`getDIMethodArguments()` Get all the method argument definitions array
`any<Array>`	`getDIProperties()` Get all the DI property definitions array
`any<array>`	`getDISetters()` Get all the DI setter definitions array
`any`	`getDSL()` Get the construction DSL
`any<struct>`	`getMemento()` Get the instance memento structure
`any`	`getMethod()` Get the method that this mapping needs to execute from a mapping factory
`any`	`getName()` Get the mapping name
`any`	`getObjectMetadata()` Get the internal mapping metadata of the object
`any<array>`	`getOnDIComplete()` Get all the DI complete methods array
`any`	`getPath()` Get the path to this mapping
`any<Array>`	`getProviderMethods()` Get the discovered provider methods array
`any`	`getScope()` Get the visibility scope
`any`	`getType()` Get the mapping type
`any`	`getValue()` Get the mapping value (if any)
`any<Boolean>`	`isAspect()` Flag describing if this mapping is an AOP aspect or not
`any<Boolean>`	`isAspectAutoBinding()` Is this mapping an auto aspect binding
`any<Boolean>`	`isAutoInit()` Using auto init of mapping target or not as boolean
`any<Boolean>`	`isAutowire()` Flag describing if you are using autowire or not as Boolean
`any<boolean>`	`isDSL()` Does this mapping have a DSL construction element or not as Boolean
`any<Boolean>`	`isDiscovered()` Checks if this mapping has already been processed or not
`any<Boolean>`	`isEagerInit()` Is this mapping eager initialized or not as Boolean
`any`	`process(any binder, any injector, [any metadata])` Process a mapping for metadata discovery and more
`private any`	`processAOPBinding(any binder, any metadata)` Process the AOP self binding aspects
`private void`	`processDIMetadata(any binder, any metadata, [any dependencies='[runtime expression]'])` Process methods/properties for dependency injection
`any`	`processMemento(any<struct> memento)` Process a mapping memento
`any`	`setAlias(any<Array> alias)` Set the mapping aliases
`any`	`setAspect(any<Boolean> aspect)` Set aspect property
`any`	`setAspectAutoBinding(any<Boolean> autoBinding)` Set the aspect auto binding bit
`any`	`setAutoInit(any autoInit)` Set autoInit property
`any`	`setAutowire(any<Boolean> autowire)` Set autowire property
`any`	`setCacheProperties(any key, [any timeout=''], [any lastAccessTimeout=''], [any provider='default'])` Set the cache properties for this mapping (Needs cachebox integration)
`any`	`setConstructor(any constructor)` Override the name of the constructor method
`any`	`setDSL(any dsl)` Set the construction DSL
`any`	`setDiscovered()` Flag this mapping as discovered
`any`	`setEagerInit(any eagerInit)` Set the eager init flag
`any`	`setMethod(any method)` Set the method used for getting this mapping from a factory
`any`	`setName(string name)` Name the mapping
`any`	`setObjectMetadata(any metadata)` Set the mappings CFC target metadata
`any`	`setOnDIComplete(any DIComplete)` Set the DI Complete method array
`any`	`setPath(any path)` Set the path to this mapping
`any`	`setScope(any scope)` Set the visibility scope
`any`	`setType(any type)` Set the mapping type
`any`	`setValue(any value)` Set the mapping value
`private any<Boolean>`	`stopClassRecursion(any classname, any binder)` Should we stop recursion or not due to class name found: Boolean

Constructor Detail

init

public init(any name)

Constructor

Parameters:: name - The mapping name

Method Detail

addDIConstructorArgument

public any addDIConstructorArgument([any name], [any ref], [any dsl], [any value], [any javaCast], [any required='true'])

Add a new constructor argument to this mapping

addDIMethodArgument

public any addDIMethodArgument([any name], [any ref], [any dsl], [any value], [any javaCast], [any required='true'])

Add a new method argument to this mapping

addDIProperty

public any addDIProperty(any name, [any ref], [any dsl], [any value], [any javaCast], [any scope='variables'])

Add a new cfproperty definition

addDISetter

public any addDISetter(any name, [any ref], [any dsl], [any value], [any javaCast])

Add a new DI setter definition

addProviderMethod

public any addProviderMethod(any method, any mapping)

Add a new provider method to this mapping

coldbox.system.ioc.config Class Mapping

init

addDIConstructorArgument

addDIMethodArgument

addDIProperty

addDISetter

addProviderMethod

getAlias

getCacheProperties

getConstructor

getDIConstructorArguments

getDIDefinition

getDIMethodArguments

getDIProperties

getDISetters

getDSL

getMemento

getMethod

getName

getObjectMetadata

getOnDIComplete

getPath

getProviderMethods

getScope

getType

getValue

isAspect

isAspectAutoBinding

isAutoInit

isAutowire

isDSL

isDiscovered

isEagerInit

process

processAOPBinding

processDIMetadata

processMemento

setAlias

setAspect

setAspectAutoBinding

setAutoInit

setAutowire

setCacheProperties

setConstructor

setDSL

setDiscovered

setEagerInit

setMethod

setName

setObjectMetadata

setOnDIComplete

setPath

setScope

setType

setValue

stopClassRecursion

coldbox.system.ioc.config
Class Mapping