.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Config::Model::Backend::Any 3pm"
.TH Config::Model::Backend::Any 3pm "2014-09-24" "perl v5.20.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Config::Model::Backend::Any \- Virtual class for other backends
.SH "VERSION"
.IX Header "VERSION"
version 2.061
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\& package Config::Model::Backend::Foo ;
\& use Mouse ;
\& use Log::Log4perl qw(get_logger :levels);
\&
\& extends \*(AqConfig::Model::Backend::Any\*(Aq;
\&
\& # optional
\& sub suffix { 
\&   return \*(Aq.foo\*(Aq;
\& }
\&
\& # mandatory
\& sub read {
\&    my $self = shift ;
\&    my %args = @_ ;
\&
\&    # args are:
\&    # root       => \*(Aq./my_test\*(Aq,  # fake root directory, userd for tests
\&    # config_dir => /etc/foo\*(Aq,    # absolute path 
\&    # file       => \*(Aqfoo.conf\*(Aq,   # file name
\&    # file_path  => \*(Aq./my_test/etc/foo/foo.conf\*(Aq 
\&    # io_handle  => $io           # IO::File object
\&    # check      => yes|no|skip
\&
\&    return 0 unless defined $args{io_handle} ; # or die?
\&
\&    foreach ($args{io_handle}\->getlines) {
\&        chomp ;
\&        s/#.*// ;
\&        next unless /\eS/; # skip blank line
\&
\&        # $data is \*(Aqfoo=bar\*(Aq which is compatible with load 
\&        $self\->node\->load(step => $_, check => $args{check} ) ;
\&    }
\&    return 1 ;
\& }
\&
\& # mandatory
\& sub write {
\&    my $self = shift ;
\&    my %args = @_ ;
\&
\&    # args are:
\&    # root       => \*(Aq./my_test\*(Aq,  # fake root directory, userd for tests
\&    # config_dir => /etc/foo\*(Aq,    # absolute path 
\&    # file       => \*(Aqfoo.conf\*(Aq,   # file name
\&    # file_path  => \*(Aq./my_test/etc/foo/foo.conf\*(Aq 
\&    # io_handle  => $io           # IO::File object
\&    # check      => yes|no|skip
\&
\&    my $ioh = $args{io_handle} ;
\&
\&    foreach my $elt ($self\->node\->get_element_name) {
\&        my $obj =  $self\->node\->fetch_element($elt) ;
\&        my $v   = $self\->node\->grab_value($elt) ;
\&
\&        # write value
\&        $ioh\->print(qq!$elt="$v"\en!) if defined $v ;
\&        $ioh\->print("\en")            if defined $v ;
\&    }
\&
\&    return 1;
\& }
\&
\& no Mouse ;
\& _\|_PACKAGE_\|_\->meta\->make_immutable ;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This Mouse class is to be inherited by other backend plugin classes
.PP
See \*(L"read callback\*(R" in Config::Model::BackendMgr and
\&\*(L"write callback\*(R" in Config::Model::BackendMgr for more details on the
method that must be provided by any backend classes.
.SH "CONSTRUCTOR"
.IX Header "CONSTRUCTOR"
.ie n .SS "new ( node => $node_obj, name => backend_name )"
.el .SS "new ( node => \f(CW$node_obj\fP, name => backend_name )"
.IX Subsection "new ( node => $node_obj, name => backend_name )"
The constructor should be used only by
Config::Model::Node.
.SH "Methods to override"
.IX Header "Methods to override"
.SS "annotation"
.IX Subsection "annotation"
Whether the backend supports to read and write annotation. Default is
0. Override if your backend supports annotations
.SH "Methods"
.IX Header "Methods"
.SS "read_global_comments( lines , comment_char)"
.IX Subsection "read_global_comments( lines , comment_char)"
Read the global comments (i.e. the first block of comments until the first blank or non comment line) and
store them as root node annotation. The first parameter (\f(CW\*(C`lines\*(C'\fR)
 is an array ref containing file lines.
.SS "associates_comments_with_data ( lines , comment_char)"
.IX Subsection "associates_comments_with_data ( lines , comment_char)"
This method will extract comments from the passed lines and associate 
them with actual data found in the file lines. Data is associated with 
comments preceding or on the same line as the data. Returns a list of
[ data, comment ] .
.PP
Example:
.PP
.Vb 3
\&  # Foo comments
\&  foo= 1
\&  Baz = 0 # Baz comments
.Ve
.PP
will return
.PP
.Vb 1
\&  ( [  \*(Aqfoo= 1\*(Aq, \*(AqFoo comments\*(Aq  ] , [ \*(AqBaz = 0\*(Aq , \*(AqBaz comments\*(Aq ] )
.Ve
.SS "write_global_comments( io_handle , comment_char)"
.IX Subsection "write_global_comments( io_handle , comment_char)"
Write global comments from configuration root annotation into the io_handle (if defined).
Returns the string written to the io_handle.
.SS "write_data_and_comments( io_handle , comment_char , data1, comment1, data2, comment2 ...)"
.IX Subsection "write_data_and_comments( io_handle , comment_char , data1, comment1, data2, comment2 ...)"
Write data and comments in the \f(CW\*(C`io_handle\*(C'\fR (if defined). Comments are written before the data.
Returns the string written to the io_handle. If a data is undef, the comment will be written on its own
line.
.SH "AUTHOR"
.IX Header "AUTHOR"
Dominique Dumont, (ddumont at cpan dot org)
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Config::Model, 
Config::Model::BackendMgr, 
Config::Model::Node, 
Config::Model::Backend::Yaml,
.SH "AUTHOR"
.IX Header "AUTHOR"
Dominique Dumont
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is Copyright (c) 2014 by Dominique Dumont.
.PP
This is free software, licensed under:
.PP
.Vb 1
\&  The GNU Lesser General Public License, Version 2.1, February 1999
.Ve