/ 
Salvation-MacroProcessor-0.93
River stage zero No dependents
/ Salvation::MacroProcessor::Connector

NAME

Salvation::MacroProcessor::Connector - An object representing interconnection between two classes

REQUIRES

Scalar::Util

Carp::Assert

MooseX::StrictConstructor

Moose

METHODS

new

 Salvation::MacroProcessor::Connector -> new(
 	name => $name,
	code => $code,
	associated_meta => $associated_meta,
	previously_associated_meta => $previously_associated_meta,
	required_shares => $required_shares
 )

name, code and associated_meta are required arguments.

Constructor.

Returns Salvation::MacroProcessor::Connector instance.

All arguments documented at this section below, or at smp_add_connector function documentation of Salvation::MacroProcessor module.

name

$object -> name();

Returns string which is the name of this connector.

code

$object -> code();

Returns CodeRef which is the actual connecting code.

associated_meta

$object -> associated_meta();

Returns Moose::Meta::Class or Moose::Meta::Role object instance corresponding to the object which has defined the connector.

previously_associated_meta

$object -> previously_associated_meta();

Returns Moose::Meta::Class or Moose::Meta::Role object instance corresponding to the object which has defined the connector. It is used when child class inherits a connector from its parent and holds the reference to parent's class metaclass.

inherited_connector

$description -> inherited_connector();

Returns Salvation::MacroProcessor::Connector object instance as it has been defined by a parent class if the connector has been inherited.

clone

$object -> clone();

Clones connector, returning new-made clone.

required_shares

$object -> required_shares();

Returns an ArrayRef. Each element is the name of required share.