Matthew Simon Cavalletto

NAME

Class::MakeMethods::Basic - Guide to subclasses

SYNOPSIS

  package MyObject;
  use Class::MakeMethods::Basic::Hash (
    'new'     => [ 'new' ],
    'scalar'  => [ 'foo', 'bar' ]
  );

  package main;   
 
  my $obj = MyObject->new( foo => "Foozle", bar => "Bozzle" );
  print $obj->foo();
  $obj->bar("Barbados");

DESCRIPTION

This document describes the various subclasses of Class::MakeMethods included under the Basic::* namespace, and the method types each one provides.

The Basic subclasses provide stripped-down method-generation implementations.

Subroutines are generated as closures bound to each method name.

Calling Conventions

When you use a subclass of this package, the method declarations you provide as arguments cause subroutines to be generated and installed in your module. You can also omit the arguments to use and instead make methods at runtime by passing the declarations to a subsequent call to make().

You may include any number of declarations in each call to use or make(). If methods with the same name already exist, earlier calls to use or make() win over later ones, but within each call, later declarations superceed earlier ones.

You can install methods in a different package by passing -TargetClass => package as your first arguments to use or make.

See "USAGE" in Class::MakeMethods for more details.

Declaration Syntax

The following types of declarations are supported:

  • generator_type => 'method_name'

  • generator_type => 'name_1 name_2...'

  • generator_type => [ 'name_1', 'name_2', ...]

For a list of the supported values of generator_type, see "SUBCLASS CATALOG" below, or the documentation for each subclass.

For each method name you provide, a subroutine of the indicated type will be generated and installed under that name in your module.

Method names should start with a letter, followed by zero or more letters, numbers, or underscores.

SUBCLASS CATALOG

Basic::Hash (Instances)

Methods for objects based on blessed hashes.

  • new: create and copy instances

  • scalar: get and set scalar values in each instance

  • array: get and set values stored in an array refered to in each instance

  • hash: get and set values in a hash refered to in each instance

Basic::Array (Instances)

Methods for manipulating positional values in arrays.

  • new: create and copy instances

  • scalar: get and set scalar values in each instance

  • array: get and set values stored in an array refered to in each instance

  • hash: get and set values in a hash refered to in each instance

Basic::Static (Global)

Static methods are not instance-dependent; calling them by class name or from any instance or subclass will consistently access the same value.

  • scalar: get and set a global scalar value

  • array: get and set values in a global array

  • hash: get and set values in a global hash

SEE ALSO

See Class::MakeMethods for an overview of the method-generation framework this is based on.

See Class::MakeMethods::Guide for a getting-started guide, annotated examples of usage, and a listing of the method generation classes included in this distribution.

See Class::MakeMethods::ReadMe for distribution, installation, version and support information.