NAME

Text::Pipe::Repeat - Common text filter API

SYNOPSIS

Text::Pipe::Repeat->new(times => 2, join => "\n");

DESCRIPTION

This is a pipe segment that takes input, repeats it a given number of times (default: 2) and join the repeated strings with a given value (default: empty string).

METHODS

clear_join
$obj->clear_join;

Clears the value that indicates how the repeated input should be joined.

clear_times
$obj->clear_times;

Clears the value that indicates how many times the input should be repeated.

filter_single

Implements the actual segment filter that acts upon a single string. It takes an input string, repeats it a number of times indicated by times() and joins the repeated strings with the value of join(), then returns it.

join
my $value = $obj->join;
$obj->join($value);

A basic getter/setter method. The value indicates how the repeated input should be joined. If called without an argument, it returns the value. If called with a single argument, it sets the value.

join_clear

Synonym for clear_join().

times
my $value = $obj->times;
$obj->times($value);

A basic getter/setter method. The value indicates how many times the input should be repeated. If called without an argument, it returns the value. If called with a single argument, it sets the value.

times_clear

Synonym for clear_times().

Text::Pipe::Repeat inherits from Text::Pipe::Base.

The superclass Text::Pipe::Base defines these methods and functions:

new(), bit_or(), filter(), init()

The superclass Class::Accessor::Complex defines these methods and functions:

mk_abstract_accessors(), mk_array_accessors(), mk_boolean_accessors(),
mk_class_array_accessors(), mk_class_hash_accessors(),
mk_class_scalar_accessors(), mk_concat_accessors(),
mk_forward_accessors(), mk_hash_accessors(), mk_integer_accessors(),
mk_new(), mk_object_accessors(), mk_scalar_accessors(),
mk_set_accessors(), mk_singleton()

The superclass Class::Accessor defines these methods and functions:

_carp(), _croak(), _mk_accessors(), accessor_name_for(),
best_practice_accessor_name_for(), best_practice_mutator_name_for(),
follow_best_practice(), get(), make_accessor(), make_ro_accessor(),
make_wo_accessor(), mk_accessors(), mk_ro_accessors(),
mk_wo_accessors(), mutator_name_for(), set()

The superclass Class::Accessor::Installer defines these methods and functions:

install_accessor()

The superclass Class::Accessor::Constructor defines these methods and functions:

_make_constructor(), mk_constructor(), mk_constructor_with_dirty(),
mk_singleton_constructor()

The superclass Data::Inherited defines these methods and functions:

every_hash(), every_list(), flush_every_cache_by_key()

The superclass Class::Accessor::Constructor::Base defines these methods and functions:

STORE(), clear_dirty(), clear_hygienic(), clear_unhygienic(),
contains_hygienic(), contains_unhygienic(), delete_hygienic(),
delete_unhygienic(), dirty(), dirty_clear(), dirty_set(),
elements_hygienic(), elements_unhygienic(), hygienic(),
hygienic_clear(), hygienic_contains(), hygienic_delete(),
hygienic_elements(), hygienic_insert(), hygienic_is_empty(),
hygienic_size(), insert_hygienic(), insert_unhygienic(),
is_empty_hygienic(), is_empty_unhygienic(), set_dirty(),
size_hygienic(), size_unhygienic(), unhygienic(), unhygienic_clear(),
unhygienic_contains(), unhygienic_delete(), unhygienic_elements(),
unhygienic_insert(), unhygienic_is_empty(), unhygienic_size()

The superclass Tie::StdHash defines these methods and functions:

CLEAR(), DELETE(), EXISTS(), FETCH(), FIRSTKEY(), NEXTKEY(), SCALAR(),
TIEHASH()

BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests through the web interface at http://rt.cpan.org.

INSTALLATION

See perlmodinstall for information and options on installing Perl modules.

AVAILABILITY

The latest version of this module is available from the Comprehensive Perl Archive Network (CPAN). Visit http://www.perl.com/CPAN/ to find a CPAN site near you. Or see http://www.perl.com/CPAN/authors/id/M/MA/MARCEL/.

The development version lives at http://github.com/hanekomu/text-pipe/. Instead of sending patches, please fork this project using the standard git and github infrastructure.

AUTHORS

Marcel Grünauer, <marcel@cpan.org>

COPYRIGHT AND LICENSE

Copyright 2007-2009 by the authors.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.