Mapping

coldbox.system.ioc.config

Class Mapping

lucee.Component
    coldbox.system.ioc.config.Mapping

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

Class Attributes:

output : false

synchronized : false

accessors : false

persistent : false

Constructor Summary
init(any name) Constructor.

Method Summary
`any`	addDIConstructorArgument([any name], [any ref], [any dsl], [any value], [any javaCast], [any required='true'], [any type='any']) Add a new constructor argument to this mapping.
`any`	addDIMethodArgument([any name], [any ref], [any dsl], [any value], [any javaCast], [any required='true'], [any type='any']) Add a new method argument to this mapping.
`any`	addDIProperty(any name, [any ref], [any dsl], [any value], [any javaCast], [any scope='variables'], [any required='true'], [any type='any']) Add a new cfproperty definition.
`any`	addDISetter(any name, [any ref], [any dsl], [any value], [any javaCast], [any argName]) Add a new DI setter definition.
`any`	addProviderMethod(any method, any mapping) Add a new provider method to this mapping.
`any`	getAlias() Get the mapping aliases array.
`any`	getCacheProperties() Get this mappings cache properties structure.
`any`	getConstructor() Get the name of the constructor method.
`any`	getDIConstructorArguments() Get all the constructor argument definitions array.
`private any<coldbox.system.ioc.config.structure>`	getDIDefinition() Get a new DI definition structure.
`any`	getDIMethodArguments() Get all the method argument definitions array.
`any`	getDIProperties() Get all the DI property definitions array.
`any`	getDISetters() Get all the DI setter definitions array.
`any`	getDSL() Get the construction DSL.
`any`	getExtraAttributes() Get the mapping's extra attributes.
`any`	getInfluenceClosure() Get the influence closure.
`any`	getMemento() Get the instance memento structure.
`any`	getMethod() Get the method that this mapping needs to execute from a mapping factory.
`any`	getMixins() Get the mixins array list.
`any`	getName() Get the mapping name.
`any`	getObjectMetadata() Get the internal mapping metadata of the object.
`any`	getOnDIComplete() Get all the DI complete methods array.
`any`	getPath() Get the path to this mapping.
`any`	getProviderMethods() Get the discovered provider methods array.
`any`	getScope() Get the visibility scope.
`any`	getThreadSafe() Get the thread safety for wiring bit.
`any`	getType() Get the mapping type.
`any`	getValue() Get the mapping value (if any).
`any`	getVirtualInheritance() Get the virtual inheritance mapping.
`any`	isAspect() Flag describing if this mapping is an AOP aspect or not.
`any`	isAspectAutoBinding() Is this mapping an auto aspect binding.
`any`	isAutoInit() Using auto init of mapping target or not as boolean.
`any`	isAutowire() Flag describing if you are using autowire or not as Boolean.
`any`	isDiscovered() Checks if this mapping has already been processed or not.
`any`	isDSL() Does this mapping have a DSL construction element or not as Boolean.
`any`	isEagerInit() Is this mapping eager initialized or not as Boolean.
`boolean`	isVirtualInheritance() Checks if the mapping needs virtual inheritace or not.
`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 memento, [any excludes='']) Process a mapping memento.
`any`	setAlias(any alias) Set the mapping aliases.
`any`	setAspect(any aspect) Set aspect property.
`any`	setAspectAutoBinding(any autoBinding) Set the aspect auto binding bit.
`any`	setAutoInit(any autoInit) Set autoInit property.
`any`	setAutowire(any 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`	setDiscovered() Flag this mapping as discovered.
`any`	setDSL(any dsl) Set the construction DSL.
`any`	setEagerInit(any eagerInit) Set the eager init flag.
`any`	setExtraAttributes(any data) Set the mapping's extra attributes.
`any`	setInfluenceClosure(any influenceClosure) Set the influence closure.
`any`	setMethod(any method) Set the method used for getting this mapping from a factory.
`any`	setMixins(any mixins) Set the mixins array list.
`any`	setName(any 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`	setThreadSafe(boolean threadSafe) Set the thread safety for wiring bit.
`any`	setType(any type) Set the mapping type.
`any`	setValue(any value) Set the mapping value.
`any`	setVirtualInheritance(any mapping) Set the virtual inheritance mapping.

Methods inherited from class `lucee.Component`
None

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'], [any type='any'])

Add a new constructor argument to this mapping

Parameters:: name - The name of the constructor argument (Not used for: JAVA,WEBSERVICE); ref - The reference mapping id this constructor argument maps to; dsl - The construction dsl this argument references. If used, the name value must be used.; value - The explicit value of the constructor argument, if passed.; javaCast - The type of javaCast() to use on the value of the argument. Only used if using dsl or ref arguments; required - If the argument is required or not, by default we assume required DI arguments.; type - The type of the argument.

addDIMethodArgument

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

Add a new method argument to this mapping

Parameters:: name - The name of the method argument (Not used for: JAVA,WEBSERVICE); ref - The reference mapping id this method argument maps to; dsl - The construction dsl this argument references. If used, the name value must be used.; value - The explicit value of the method argument, if passed.; javaCast - The type of javaCast() to use on the value of the argument. Only used if using dsl or ref arguments; required - If the argument is required or not, by default we assume required DI arguments.; type - The type of the argument.

addDIProperty

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

Add a new cfproperty definition

Parameters:: name - The name of the cfproperty to inject; ref - The reference mapping id this property maps to; dsl - The construction dsl this property references. If used, the name value must be used.; value - The value of the property, if passed.; javaCast - The type of javaCast() to use on the value of the property. Only used if using dsl or ref arguments; scope - The scope in the CFC to inject the property to. By default it will inject it to the variables scope; required - If the property is required or not, by default we assume required DI properties.; type - The type of the property.

addDISetter

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

Add a new DI setter definition

Parameters:: name - The name of the setter method.; ref - The reference mapping id this setter argument maps to; dsl - The construction dsl this argument references. If used, the name value must be used.; value - The value of the setter argument, if passed.; javaCast - The type of javaCast() to use on the value of the argument. Only used if using dsl or ref arguments; argName - The name of the argument to use, if not passed, we default it to the setter name

addProviderMethod

public any addProviderMethod(any method, any mapping)

Add a new provider method to this mapping

Parameters:: method - The provided method to override as a provider; mapping - The mapping to provide via the selected method

getAlias

public any getAlias()

Get the mapping aliases array

getCacheProperties

public any getCacheProperties()

Get this mappings cache properties structure

getConstructor

public any getConstructor()

Get the name of the constructor method

getDIConstructorArguments

public any getDIConstructorArguments()

Get all the constructor argument definitions array

getDIDefinition

private any<coldbox.system.ioc.config.structure> getDIDefinition()

Get a new DI definition structure

getDIMethodArguments

public any getDIMethodArguments()

Get all the method argument definitions array

getDIProperties

public any getDIProperties()

Get all the DI property definitions array

getDISetters

public any getDISetters()

Get all the DI setter definitions array

getDSL

public any getDSL()

Get the construction DSL

getExtraAttributes

public any getExtraAttributes()

Get the mapping's extra attributes

getInfluenceClosure

public any getInfluenceClosure()

Get the influence closure. Empty string if not exists

getMemento

public any getMemento()

Get the instance memento structure

getMethod

public any getMethod()

Get the method that this mapping needs to execute from a mapping factory

getMixins

public any getMixins()

Get the mixins array list

getName

public any getName()

Get the mapping name

getObjectMetadata

public any getObjectMetadata()

Get the internal mapping metadata of the object

getOnDIComplete

public any getOnDIComplete()

Get all the DI complete methods array

getPath

public any getPath()

Get the path to this mapping

getProviderMethods

public any getProviderMethods()

Get the discovered provider methods array

getScope

public any getScope()

Get the visibility scope

getThreadSafe

public any getThreadSafe()

Get the thread safety for wiring bit

getType

public any getType()

Get the mapping type

getValue

public any getValue()

Get the mapping value (if any)

getVirtualInheritance

public any getVirtualInheritance()

Get the virtual inheritance mapping

isAspect

public any isAspect()

Flag describing if this mapping is an AOP aspect or not

isAspectAutoBinding

public any isAspectAutoBinding()

Is this mapping an auto aspect binding

isAutoInit

public any isAutoInit()

Using auto init of mapping target or not as boolean

isAutowire

public any isAutowire()

Flag describing if you are using autowire or not as Boolean

isDiscovered

public any isDiscovered()

Checks if this mapping has already been processed or not

isDSL

public any isDSL()

Does this mapping have a DSL construction element or not as Boolean

isEagerInit

public any isEagerInit()

Is this mapping eager initialized or not as Boolean

isVirtualInheritance

public boolean isVirtualInheritance()

Checks if the mapping needs virtual inheritace or not

process

public any process(any binder, any injector, [any metadata])

Process a mapping for metadata discovery and more

Parameters:: binder - The binder requesting the processing; injector - The calling injector processing the mappping; metadata - The metadata of an a-la-carte processing, use instead of retrieveing again

processAOPBinding

private any processAOPBinding(any binder, any metadata)

Process the AOP self binding aspects

Parameters:: binder - The binder requesting the processing; metadata - The metadata to process

processDIMetadata

private void processDIMetadata(any binder, any metadata, [any dependencies='[runtime expression]'])

Process methods/properties for dependency injection

Parameters:: binder - The binder requesting the processing; metadata - The metadata to process; dependencies - The dependencies structure

processMemento

public any processMemento(any memento, [any excludes=''])

Process a mapping memento

Parameters:: memento - The data memento to process; excludes - List of instance's memento keys to not process

setAlias

public any setAlias(any alias)

Set the mapping aliases

Parameters:: alias

setAspect

public any setAspect(any aspect)

Set aspect property

Parameters:: aspect

setAspectAutoBinding

public any setAspectAutoBinding(any autoBinding)

Set the aspect auto binding bit

Parameters:: autoBinding

setAutoInit

public any setAutoInit(any autoInit)

Set autoInit property

Parameters:: autoInit

setAutowire

public any setAutowire(any autowire)

Set autowire property

Parameters:: autowire

setCacheProperties

public any setCacheProperties(any key, [any timeout=''], [any lastAccessTimeout=''], [any provider='default'])

Set the cache properties for this mapping (Needs cachebox integration)

Parameters:: key - Cache key to use; timeout - Object Timeout; lastAccessTimeout - Object Last Access Timeout; provider - The Cache Provider to use

setConstructor

public any setConstructor(any constructor)

Override the name of the constructor method

Parameters:: constructor

setDiscovered

public any setDiscovered()

Flag this mapping as discovered

setDSL

public any setDSL(any dsl)

Set the construction DSL

Parameters:: dsl

setEagerInit

public any setEagerInit(any eagerInit)

Set the eager init flag

Parameters:: eagerInit - Set the eager init flag

setExtraAttributes

public any setExtraAttributes(any data)

Set the mapping's extra attributes

Parameters:: data

setInfluenceClosure

public any setInfluenceClosure(any influenceClosure)

Set the influence closure.

Parameters:: influenceClosure

setMethod

public any setMethod(any method)

Set the method used for getting this mapping from a factory

Parameters:: method

setMixins

public any setMixins(any mixins)

Set the mixins array list

Parameters:: mixins

setName

public any setName(any name)

Name the mapping

Parameters:: name

setObjectMetadata

public any setObjectMetadata(any metadata)

Set the mappings CFC target metadata

Parameters:: metadata - Target CFC metadata

setOnDIComplete

public any setOnDIComplete(any DIComplete)

Set the DI Complete method array

Parameters:: DIComplete - The method array to set

setPath

public any setPath(any path)

Set the path to this mapping

Parameters:: path

setScope

public any setScope(any scope)

Set the visibility scope

Parameters:: scope

setThreadSafe

public any setThreadSafe(boolean threadSafe)

Set the thread safety for wiring bit

Parameters:: threadSafe

setType

public any setType(any type)

Set the mapping type

Parameters:: type

setValue

public any setValue(any value)

Set the mapping value

Parameters:: value

setVirtualInheritance

public any setVirtualInheritance(any mapping)

Set the virtual inheritance mapping

Parameters:: mapping