Test::AutoBuild::Counter - The base class for an AutoBuild stage

Test-AutoBuild documentation Contained in the Test-AutoBuild distribution.

Index

Code Index:

NAME

Top

Test::AutoBuild::Counter - The base class for an AutoBuild stage

SYNOPSIS

Top

  use Test::AutoBuild::Counter;

  my $counter = Test::AutoBuild::Counter->new(options => \%options);

  # Retrieve the current counter
  $counter->value();

METHODS

Top

my $stage = Test::AutoBuild::Counter->new(options => %options);

Creates a new counter, with the options parameter providing in any sub-class specific configuration options.

$value = $counter->option($name[, $newvalue]);

Retrieves the subclass specific configuration option specified by the $name parameter. If the $newvalue parameter is supplied, then the configuration option is updated.

$counter->generate($runtime);

This method should be implemented by subclasses to the logic required to generate the next build counter.

AUTHORS

Top

Daniel Berrange <dan@berrange.com>, Dennis Gregorovic <dgregorovic@alum.mit.edu>

COPYRIGHT

Top

Copyright (C) 2005 Daniel Berrange

SEE ALSO

Top

perl(1), Test::AutoBuild, Test::AutoBuild::Runtime

Test-AutoBuild documentation Contained in the Test-AutoBuild distribution. 
# -*- perl -*-
#
# Test::AutoBuild::Counter
#
# Daniel Berrange <dan@berrange.com>
# Dennis Gregorovic <dgregorovic@alum.mit.edu>
#
# Copyright (C) 2005 Daniel Berrange
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
#
# $Id: Counter.pm,v 1.6 2007/12/08 17:35:16 danpb Exp $


package Test::AutoBuild::Counter;

use warnings;
use strict;
use Log::Log4perl;


sub new {
    my $proto = shift;
    my $class = ref($proto) || $proto;
    my $self = {};
    my %params = @_;

    $self->{options} = exists $params{options} ? $params{options} : {};

    bless $self, $class;

    return $self;
}



sub option {
   my $self = shift;
   my $name = shift;

   $self->{options}->{$name} = shift if @_;

   return $self->{options}->{$name};
}



sub generate {
    my $self = shift;
    my $runtime = shift;

    die "class " . ref($self) . " forgot to implement the generate method";
}

1 # So that the require or use succeeds.

__END__