Pipeline::Production - wrapper for production objects

Pipeline documentation Contained in the Pipeline distribution.

Index

Code Index:

NAME

Top

Pipeline::Production - wrapper for production objects

SYNOPSIS

Top

  use Pipeline::Production;

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

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

DESCRIPTION

Top

The Pipeline::Production 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.

METHODS

Top

new()

The new method constructs a fresh Pipeline::Production object and returns it. In the process it calls the init() method.

init()

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

contents( [ SCALAR ] )

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

contains( [ SCALAR ] )

A synonym for contents

SEE ALSO

Top

Pipeline

AUTHOR

Top

James A. Duncan <jduncan@fotango.com>

COPYRIGHT

Top

Copyright 2003 Fotango Ltd. All Rights Reserved.

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

Pipeline documentation Contained in the Pipeline distribution. 
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;