|
ColdBox Platform Version 3.7.0 | ||||
FRAMES |
WEB-INF.cftags.componentcoldbox.system.ioc.config.Mapping
public class Mapping
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], [any argName])
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 |
getExtraAttributes()
Get the mapping's extra attributes |
any<struct> |
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<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 |
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<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 |
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<struct> memento, [any excludes=''])
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 |
setExtraAttributes(any data)
Set the mapping's extra attributes |
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 WEB-INF.cftags.component |
---|
|
Constructor Detail |
---|
public init(any name)
name
- The mapping nameMethod Detail |
---|
public any addDIConstructorArgument([any name], [any ref], [any dsl], [any value], [any javaCast], [any required='true'])
name
- The name of the constructor argument (Not used for: JAVA,WEBSERVICE)ref
- The reference mapping id this constructor argument maps todsl
- 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 argumentsrequired
- If the argument is required or not, by default we assume required DI arguments.public any addDIMethodArgument([any name], [any ref], [any dsl], [any value], [any javaCast], [any required='true'])
name
- The name of the method argument (Not used for: JAVA,WEBSERVICE)ref
- The reference mapping id this method argument maps todsl
- 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 argumentsrequired
- If the argument is required or not, by default we assume required DI arguments.public any addDIProperty(any name, [any ref], [any dsl], [any value], [any javaCast], [any scope='variables'])
name
- The name of the cfproperty to injectref
- The reference mapping id this property maps todsl
- 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 argumentsscope
- The scope in the CFC to inject the property to. By default it will inject it to the variables scopepublic any addDISetter(any name, [any ref], [any dsl], [any value], [any javaCast], [any argName])
name
- The name of the setter method.ref
- The reference mapping id this setter argument maps todsl
- 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 argumentsargName
- The name of the argument to use, if not passed, we default it to the setter namepublic any addProviderMethod(any method, any mapping)
method
- The provided method to override as a providermapping
- The mapping to provide via the selected methodpublic any<Array> getAlias()
public any<struct> getCacheProperties()
public any getConstructor()
public any<array> getDIConstructorArguments()
private any<coldbox.system.ioc.config.structure> getDIDefinition()
public any<array> getDIMethodArguments()
public any<Array> getDIProperties()
public any<array> getDISetters()
public any getDSL()
public any getExtraAttributes()
public any<struct> getMemento()
public any getMethod()
public any getMixins()
public any getName()
public any getObjectMetadata()
public any<array> getOnDIComplete()
public any getPath()
public any<Array> getProviderMethods()
public any getScope()
public any getThreadSafe()
public any getType()
public any getValue()
public any getVirtualInheritance()
public any<Boolean> isAspect()
public any<Boolean> isAspectAutoBinding()
public any<Boolean> isAutoInit()
public any<Boolean> isAutowire()
public any<boolean> isDSL()
public any<Boolean> isDiscovered()
public any<Boolean> isEagerInit()
public boolean isVirtualInheritance()
public any process(any binder, any injector, [any metadata])
binder
- The binder requesting the processinginjector
- The calling injector processing the mapppingmetadata
- The metadata of an a-la-carte processing, use instead of retrieveing againprivate any processAOPBinding(any binder, any metadata)
binder
- The binder requesting the processingmetadata
- The metadata to processprivate void processDIMetadata(any binder, any metadata, [any dependencies='[runtime expression]'])
binder
- The binder requesting the processingmetadata
- The metadata to processdependencies
- The dependencies structurepublic any processMemento(any<struct> memento, [any excludes=''])
memento
- The data memento to processexcludes
- List of instance's memento keys to not processpublic any setAlias(any<Array> alias)
alias
public any setAspect(any<Boolean> aspect)
aspect
public any setAspectAutoBinding(any<Boolean> autoBinding)
autoBinding
public any setAutoInit(any autoInit)
autoInit
public any setAutowire(any<Boolean> autowire)
autowire
public any setCacheProperties(any key, [any timeout=''], [any lastAccessTimeout=''], [any provider='default'])
key
- Cache key to usetimeout
- Object TimeoutlastAccessTimeout
- Object Last Access Timeoutprovider
- The Cache Provider to usepublic any setConstructor(any constructor)
constructor
public any setDSL(any dsl)
dsl
public any setDiscovered()
public any setEagerInit(any eagerInit)
eagerInit
- Set the eager init flagpublic any setExtraAttributes(any data)
data
public any setMethod(any method)
method
public any setMixins(any mixins)
mixins
public any setName(any name)
name
public any setObjectMetadata(any metadata)
metadata
- Target CFC metadatapublic any setOnDIComplete(any DIComplete)
DIComplete
- The method array to setpublic any setPath(any path)
path
public any setScope(any scope)
scope
public any setThreadSafe(boolean threadSafe)
threadSafe
public any setType(any type)
type
public any setValue(any value)
value
public any setVirtualInheritance(any mapping)
mapping
|
ColdBox Platform Version 3.7.0 | ||||
FRAMES |