NAME

SYNOPSIS

  package MyObject;
  use Class::MakeMethods::Emulator::MethodMaker( 
    new_with_init => 'new',
    get_set       => [ qw / foo bar baz / ];
  );

  ... OR ...

  package MyObject;
  use Class::MakeMethods::Emulator::MethodMaker '-take_namespace';
  use Class::MethodMaker ( 
    new_with_init => 'new',
    get_set       => [ qw / foo bar baz / ];
  );

DESCRIPTION

Although originally based on Class::MethodMaker, the calling convention for Class::MakeMethods differs in a variety of ways; most notably, the names given to various types of methods have been changed, and the format for specifying method attributes has been standardized. This package uses the aliasing capability provided by Class::MakeMethods, defining methods that modify the declaration arguments as necessary and pass them off to various subclasses of Class::MakeMethods.

COMPATIBILITY

The test suite from Class::MethodMaker version 1.10 is included with this package, in the t/emulator_class_methodmaker/ directory. The unsupported tests have names ending in ".todo".

The tests are unchanged from those in the Class::MethodMaker distribution, except for the substitution of "Class::MakeMethods::Emulator::MethodMaker" in the place of "Class::MethodMaker".

In cases where earlier distributions of Class::MethodMaker contained a different version of a test, it is also included. (Note that version 0.92's get_concat returned '' for empty values, but in version 0.96 this was changed to undef; this emulator follows the later behavior. To avoid "use of undefined value" warnings from the 0.92 version of get_concat.t, that test has been modified by appending a new flag after the name, 'get_concat --noundef', which restores the earlier behavior.)

USAGE

• Direct Access

  Replace occurances in your code of "Class::MethodMaker" with "Class::MakeMethods::Emulator::MethodMaker".

• Install Emulation

  If you "use Class::MakeMethods::Emulator::MethodMaker '-take_namespace'", the Class::MethodMaker namespace will be aliased to this package, and calls to the original package will be transparently handled by this emulator.

  To remove the emulation aliasing, call "use Class::MakeMethods::Emulator::MethodMaker '-release_namespace'".

  Note: This affects all subsequent uses of Class::MethodMaker in your program, including those in other modules, and might cause unexpected effects.

• The -sugar Option

  Passing '-sugar' as the first argument in a use or import call will cause the 'methods' package to be declared as an alias to this one.

  This allows you to write declarations in the following manner.

    use Class::MakeMethods::Emulator::MethodMaker '-sugar';
  
    make methods
      get_set => [ qw / foo bar baz / ],
      list    => [ qw / a b c / ];
      

  Note: This feature is deprecated in Class::MethodMaker version 0.96 and later.

METHOD CATALOG

CONSTRUCTOR METHODS

SCALAR ACCESSORS

OBJECT ACCESSORS

  forward => [ comp => 'method1', comp2 => 'method2' ]

REFERENCE ACCESSORS

STATIC ACCESSORS

GROUPED ACCESSORS

  use Class::MakeMethods::Emulator::MethodMaker
    grouped_fields => [
      some_group => [ qw / field1 field2 field3 / ],
    ];

INDEXED ACCESSORS

CODE ACCESSORS

ARRAY CONSTRUCTOR AND ACCESSORS

CONVERSION

Often this is simply a matter of replacing the names of aliased method-types listed below with the new equivalents.

For example, suppose that you code contained the following declaration:

  use Class::MethodMaker ( 
    counter => [ 'foo' ]
  );

Consulting the listings below you can find that "counter" is an alias for "Hash:number --counter" and you could thus revise your declaration to read:

  use Class::MakeMethods ( 
    'Hash:number --counter' => [ 'foo' ] 
  );

However, note that those methods marked "(with custom interface)" below have a different default naming convention for helper methods in Class::MakeMethods, and you will need to either supply a similar interface or alter your module's calling interface.

Also note that the "forward", "object", and "object_list" method types, marked "(with modified arguments)" below, require their arguments to be specified differently.

See Class::MakeMethods::Template::Generic for more information about the default interfaces of these method types.

  new              'Template::Hash:new --with_values'
  new_with_init    'Template::Hash:new --with_init'
  new_hash_init    'Template::Hash:new --instance_with_methods'
  copy             'Template::Hash:copy'
  get_set          'Template::Hash:scalar' (with custom interfaces)
  counter          'Template::Hash:number --counter'
  get_concat       'Template::Hash:string --get_concat' (with custom interface)
  boolean          'Template::Hash:bits' (with custom interface)
  list             'Template::Hash:array' (with custom interface)
  struct           'Template::Hash:struct'
  hash             'Template::Hash:hash' (with custom interface)
  tie_hash         'Template::Hash:tiedhash' (with custom interface)
  hash_of_lists    'Template::Hash:hash_of_arrays'
  code             'Template::Hash:code'
  method           'Template::Hash:code --method'
  object           'Template::Hash:object' (with custom interface and modified arguments)
  object_list      'Template::Hash:array_of_objects' (with custom interface and modified arguments)
  key_attrib       'Template::Hash:string_index'
  key_with_create  'Template::Hash:string_index --find_or_new'

  static_get_set   'Template::Static:scalar' (with custom interface)
  static_hash      'Template::Static:hash' (with custom interface)

  listed_attrib   'Template::Flyweight:boolean_index'

  builtin_class   'Template::Struct:builtin_isa'

  abstract         'Template::Universal:croak --abstract'
  forward          'Template::Universal:forward_methods' (with modified arguments)

EXTENDING

• install_methods - now simply return the desired methods
• find_target_class - now passed in as the target_class attribute
• ima_method_maker - no longer supported; use target_class instead

BUGS

SEE ALSO

See Class::MakeMethods::Emulator for more about this family of subclasses.

See Class::MethodMaker for more information about the original module.

A good introduction to Class::MethodMaker is provided by pages 222-234 of Object Oriented Perl, by Damian Conway (Manning, 1999).

  http://www.browsebooks.com/Conway/