/ 
Rsync-Config-0.2
/ Rsync::Config::Module

NAME

Rsync::Config::Module

VERSION

0.2

DESCRIPTION

A module is a module entry from a rsync configuration file. Ex: [cpan] path = /var/ftp/pub/mirrors/ftp.cpan.org/ comment = CPAN mirror

Rsync::Config::Module is used to create a module who can be later used in generating a rsync configuration file. Each module is made by atoms (Rsync::Config::Atom).

SYNOPSIS

use Rsync::Config::Module;

sub main {
  my $mod_cpan;

  $mod_cpan = new Rsync::Config::Module(name => 'cpan');

  $mod_cpan->add_atom(name => 'path', value => '/var/ftp/pub/mirrors/ftp.cpan.org/');
  $mod_cpan->add_atom(name => 'comment', value => 'CPAN mirror');
}

SUBROUTINES/METHODS

Please note that some methods may throw exceptions. Check the documentation for each method to see what exceptions may be throwned.

new(%opt)

The class contructor. %opt must contain at least a key named name with the name of the module. Name and value must be specified, except for __blank__ atoms. new may throw the following exceptions:

*) REX::Param::Missing - when name is not specified
*) REX::Param::Undef - when name is not defined
*) REX::Param::Invalid - when name is blank or 0

add_blank()

Adds a blank atom to this module. Returns the object. This method internally calles Rsync::Config::Atom constructor.

add_comment($comment)

Adds a comment atom to this module. Returns the object. This method internally calles Rsync::Config::Atom constructor with $comment parameter. Please read Rsync::Config::Atom contructor documentation to see if any exceptions are throwned.

add_atom($name, $value)

Adds a new atom to this module. This method internally calles Rsync::Config::Atom constructor with $name and $value parameters. Please read Rsync::Config::Atom contructor documentation to see if any exceptions are throwned.

add_atom_obj($atom_obj)

Adds a previsiously created atom object to the list of current atoms. If $atom_obj is not a instance of Rsync::Config::Atom REX::Param::Invalid exception is throwned.

atoms_no()

Returns the number of current atoms.

atoms()

In scalar context returns a array reference to the list of current atoms. In array content returns a array of current atoms.

to_string()

Returns the string representation of the current module. If indent is true, a best of effort is made to indent the module.

DEPENDENCIES

Rsync::Config::Module uses the following modules:

English
Scalar::Util
CLASS

DIAGNOSTICS

All tests are located in the t directory .

PERL CRITIC

This module is perl critic level 1 compliant.

CONFIGURATION AND ENVIRONMENT

This module does not use any configuration files or environment variables. The used modules however may use such things. Please refer to each module man page for more information.

INCOMPATIBILITIES

None known to the author

BUGS AND LIMITATIONS

Using atoms with values 0 or undef will trigger exceptions.

SEE ALSO

Rsync::Config::Exceptions Rsync::Config::Atom Rsync::Config Rsync::Config::Renderer

AUTHOR

Subredu Manuel <diablo@packages.ro>

LICENSE AND COPYRIGHT

Copyright (C) 2006 Subredu Manuel. All Rights Reserved. This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The LICENSE file contains the full text of the license.