File Coverage

blib/lib/Pipeline/Production.pm

Criterion	Covered	Total	%
statement	24	25	96.0
branch	3	4	75.0
condition			n/a
subroutine	7	7	100.0
pod	3	3	100.0
total	37	39	94.8

package Pipeline::Production;

use strict;
use warnings::register;

use Pipeline::Base;
use base qw( Pipeline::Base );

our $VERSION = "3.12";

sub init {
  my $self = shift;
  if ($self->SUPER::init( @_ )) {
    $self->contents( '' );
    return 1;
  } else {
    return 0;
  }
}

sub contents {
  my $self = shift;
  $self->contains( @_ );
}

sub contains {
  my $self = shift;
  my $cont = shift;
  if (defined( $cont )) {
    $self->{ production_contains } = $cont;
    return $self;
  } else {
    return $self->{ production_contains };
  }
}

1;


=head1 NAME

Pipeline::Production - wrapper for production objects

=head1 SYNOPSIS

  use Pipeline::Production;

  my $pp = Pipeline::Production->new();

  $pp->contents( $object );
  my $production = $pp->contents();

=head1 DESCRIPTION

The C class acts as a wrapper around any scalar
(and therfore object, or reference) that a Pipeline is to consider as
a production.  A production object will terminate the pipeline apon receipt
and cause the cleanup segments to be executed.

=head1 METHODS

=over 4

=item new()

The C method constructs a fresh Pipeline::Production object and
returns it.  In the process it calls the C method.

=item init()

The C method is called at construction time to perform any pre-use
initialization on the object.

=item contents( [ SCALAR ] )

The C method gets or sets the contents of the production, ie, the
actual production itself.

=item contains( [ SCALAR ] )

A synonym for C

=back

=head1 SEE ALSO

C

=head1 AUTHOR

James A. Duncan

=head1 COPYRIGHT

Copyright 2003 Fotango Ltd. All Rights Reserved.

This software is released under the same terms as Perl itself.

=cut