Class::MakeMethods::Basic::Hash - Basic hash methods |
Class::MakeMethods::Basic::Hash - Basic hash methods
package MyObject; use Class::MakeMethods::Basic::Hash ( new => 'new', scalar => [ 'foo', 'bar' ], array => 'my_list', hash => 'my_index', ); ... # Constructor my $obj = MyObject->new( foo => 'Foozle' ); # Scalar Accessor print $obj->foo(); $obj->bar('Barbados'); print $obj->bar(); # Array accessor $obj->my_list(0 => 'Foozle', 1 => 'Bang!'); print $obj->my_list(1); # Hash accessor $obj->my_index('broccoli' => 'Blah!', 'foo' => 'Fiddle'); print $obj->my_index('foo');
The Basic::Hash subclass of MakeMethods provides a basic constructor and accessors for blessed-hash object instances.
When you use
this package, the method names you provide
as arguments cause subroutines to be generated and installed in
your module.
See Calling Conventions in the Class::MakeMethods::Basic manpage for a summary, or USAGE in the Class::MakeMethods manpage for full details.
To declare methods, pass in pairs of a method-type name followed by one or more method names. Valid method-type names for this package are listed in METHOD GENERATOR TYPES.
See Declaration Syntax in the Class::MakeMethods::Basic manpage for more syntax information.
For each method name passed, returns a subroutine with the following characteristics:
Sample declaration and usage:
package MyObject; use Class::MakeMethods::Basic::Hash ( new => 'new', ); ... # Bare constructor my $empty = MyObject->new(); # Constructor with initial values my $obj = MyObject->new( foo => 'Foozle', bar => 'Barbados' ); # Copy with overriding value my $copy = $obj->new( bar => 'Bob' );
For each method name passed, uses a closure to generate a subroutine with the following characteristics:
Sample declaration and usage:
package MyObject; use Class::MakeMethods::Basic::Hash ( scalar => 'foo', ); ... # Store value $obj->foo('Foozle'); # Retrieve value print $obj->foo;
For each method name passed, uses a closure to generate a subroutine with the following characteristics:
Sample declaration and usage:
package MyObject; use Class::MakeMethods::Basic::Hash ( array => 'bar', ); ...
# Set values by position $obj->bar(0 => 'Foozle', 1 => 'Bang!');
# Positions may be overwritten, and in any order $obj->bar(2 => 'And Mash', 1 => 'Blah!');
# Retrieve value by position print $obj->bar(1);
# Direct access to referenced array print scalar @{ $obj->bar() };
# Reset the array contents to empty @{ $obj->bar() } = ();
For each method name passed, uses a closure to generate a subroutine with the following characteristics:
Sample declaration and usage:
package MyObject; use Class::MakeMethods::Basic::Hash ( hash => 'baz', ); ...
# Set values by key $obj->baz('foo' => 'Foozle', 'bar' => 'Bang!');
# Values may be overwritten, and in any order $obj->baz('broccoli' => 'Blah!', 'foo' => 'Fiddle');
# Retrieve value by key print $obj->baz('foo');
# Direct access to referenced hash print keys %{ $obj->baz() };
# Reset the hash contents to empty @{ $obj->baz() } = ();
See the Class::MakeMethods manpage for general information about this distribution.
See the Class::MakeMethods::Basic manpage for more about this family of subclasses.
See the Class::MakeMethods::Basic::Array manpage for equivalent functionality based on blessed arrays. If all access to your object is through constructors and accessors declared using this package, and your class will not be extensively subclassed, consider switching to Basic::Array to minimize resource consumption.
Class::MakeMethods::Basic::Hash - Basic hash methods |