summaryrefslogtreecommitdiff
path: root/lib/Class/MakeMethods/Basic/Hash.pm
diff options
context:
space:
mode:
authorAndreas Brachold <vdr07@deltab.de>2007-11-10 17:53:53 +0000
committerAndreas Brachold <vdr07@deltab.de>2007-11-10 17:53:53 +0000
commitcfdd733c17cfa4f1a43b827a656e9e53cc2524ac (patch)
treeb6f659b1281f77628b36768f0888f67b65f9ca48 /lib/Class/MakeMethods/Basic/Hash.pm
parent9c6c30350161efd74faa3c3705096aecb71c0e81 (diff)
downloadxxv-cfdd733c17cfa4f1a43b827a656e9e53cc2524ac.tar.gz
xxv-cfdd733c17cfa4f1a43b827a656e9e53cc2524ac.tar.bz2
* Remove unsed packages
* Reorder exit routines
Diffstat (limited to 'lib/Class/MakeMethods/Basic/Hash.pm')
-rw-r--r--lib/Class/MakeMethods/Basic/Hash.pm362
1 files changed, 0 insertions, 362 deletions
diff --git a/lib/Class/MakeMethods/Basic/Hash.pm b/lib/Class/MakeMethods/Basic/Hash.pm
deleted file mode 100644
index 7a55106..0000000
--- a/lib/Class/MakeMethods/Basic/Hash.pm
+++ /dev/null
@@ -1,362 +0,0 @@
-=head1 NAME
-
-Class::MakeMethods::Basic::Hash - Basic hash methods
-
-
-=head1 SYNOPSIS
-
- 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');
-
-
-=head1 DESCRIPTION
-
-The Basic::Hash subclass of MakeMethods provides a basic constructor and accessors for blessed-hash object instances.
-
-=head2 Calling Conventions
-
-When you C<use> this package, the method names you provide
-as arguments cause subroutines to be generated and installed in
-your module.
-
-See L<Class::MakeMethods::Basic/"Calling Conventions"> for a summary, or L<Class::MakeMethods/"USAGE"> for full details.
-
-=head2 Declaration Syntax
-
-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 L<"METHOD GENERATOR TYPES">.
-
-See L<Class::MakeMethods::Basic/"Declaration Syntax"> for more
-syntax information.
-
-
-=cut
-
-package Class::MakeMethods::Basic::Hash;
-
-$VERSION = 1.000;
-use strict;
-use Class::MakeMethods '-isasubclass';
-
-########################################################################
-
-=head1 METHOD GENERATOR TYPES
-
-=head2 new - Constructor
-
-For each method name passed, returns a subroutine with the following characteristics:
-
-=over 4
-
-=item *
-
-If called as a class method, makes a new hash and blesses it into that class.
-
-=item *
-
-If called on a hash-based instance, makes a copy of it and blesses the copy into the same class as the original instance.
-
-=item *
-
-If passed a list of key-value pairs, appends them to the new hash. These arguments override any copied values, and later arguments with the same name will override earlier ones.
-
-=item *
-
-Returns the new instance.
-
-=back
-
-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' );
-
-=cut
-
-sub new {
- my $class = shift;
- map {
- my $name = $_;
- $name => sub {
- my $callee = shift;
- if ( ref $callee ) {
- bless { %$callee, @_ }, ref $callee;
- } else {
- bless { @_ }, $callee;
- }
- }
- } @_;
-}
-
-########################################################################
-
-=head2 scalar - Instance Accessor
-
-For each method name passed, uses a closure to generate a subroutine with the following characteristics:
-
-=over 4
-
-=item *
-
-Must be called on a hash-based instance.
-
-=item *
-
-Uses the method name as a hash key to access the related value for each instance.
-
-=item *
-
-If called without any arguments returns the current value.
-
-=item *
-
-If called with an argument, stores that as the value, and returns it,
-
-=back
-
-Sample declaration and usage:
-
- package MyObject;
- use Class::MakeMethods::Basic::Hash (
- scalar => 'foo',
- );
- ...
-
- # Store value
- $obj->foo('Foozle');
-
- # Retrieve value
- print $obj->foo;
-
-=cut
-
-sub scalar {
- my $class = shift;
- map {
- my $name = $_;
- $name => sub {
- if ( scalar @_ > 1 ) {
- $_[0]->{$name} = $_[1];
- } else {
- $_[0]->{$name};
- }
- }
- } @_;
-}
-
-########################################################################
-
-=head2 array - Instance Ref Accessor
-
-For each method name passed, uses a closure to generate a subroutine with the following characteristics:
-
-=over 4
-
-=item *
-
-Must be called on a hash-based instance.
-
-=item *
-
-Uses the method name as a hash key to access the related value for each instance.
-
-=item *
-
-The value for each instance will be a reference to an array (or undef).
-
-=item *
-
-If called without any arguments, returns the current array-ref value (or undef).
-
-=item *
-
-If called with one argument, uses that argument as an index to retrieve from the referenced array, and returns that value (or undef).
-
-=item *
-
-If called with a list of index-value pairs, stores the value at the given index in the referenced array. If the instance's value was previously undefined, a new array is autovivified. The current value in each position will be overwritten, and later arguments with the same index will override earlier ones. Returns the current array-ref value.
-
-=back
-
-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() } = ();
-
-=cut
-
-sub array {
- my $class = shift;
- map {
- my $name = $_;
- $name => sub {
- my $self = shift;
- if ( scalar(@_) == 0 ) {
- return $self->{$name};
- } elsif ( scalar(@_) == 1 ) {
- $self->{$name}->[ shift() ];
- } elsif ( scalar(@_) % 2 ) {
- Carp::croak "Odd number of items in assigment to $name";
- } else {
- while ( scalar(@_) ) {
- my $key = shift();
- $self->{$name}->[ $key ] = shift();
- }
- return $self->{$name};
- }
- }
- } @_;
-}
-
-########################################################################
-
-=head2 hash - Instance Ref Accessor
-
-For each method name passed, uses a closure to generate a subroutine with the following characteristics:
-
-=over 4
-
-=item *
-
-Must be called on a hash-based instance.
-
-=item *
-
-Uses the method name as a hash key to access the related value for each instance.
-
-=item *
-
-The value for each instance will be a reference to a hash (or undef).
-
-=item *
-
-If called without any arguments, returns the current hash-ref value (or undef).
-
-=item *
-
-If called with one argument, uses that argument as an index to retrieve from the referenced hash, and returns that value (or undef).
-
-=item *
-
-If called with a list of key-value pairs, stores the value under the given key in the referenced hash. If the instance's value was previously undefined, a new hash is autovivified. The current value under each key will be overwritten, and later arguments with the same key will override earlier ones. Returns the current hash-ref value.
-
-=back
-
-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() } = ();
-
-=cut
-
-sub hash {
- my $class = shift;
- map {
- my $name = $_;
- $name => sub {
- my $self = shift;
- if ( scalar(@_) == 0 ) {
- return $self->{$name};
- } elsif ( scalar(@_) == 1 ) {
- $self->{$name}->{ shift() };
- } elsif ( scalar(@_) % 2 ) {
- Carp::croak "Odd number of items in assigment to $name";
- } else {
- while ( scalar(@_) ) {
- $self->{$name}->{ shift() } = shift();
- }
- return $self->{$name};
- }
- }
- } @_;
-}
-
-########################################################################
-
-=head1 SEE ALSO
-
-See L<Class::MakeMethods> for general information about this distribution.
-
-See L<Class::MakeMethods::Basic> for more about this family of subclasses.
-
-See L<Class::MakeMethods::Basic::Array> 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.
-
-=cut
-
-1;