package XML::Mini::Element::Comment;
use strict;
$^W = 1;

use XML::Mini;
use XML::Mini::Element;

use vars qw ( $VERSION @ISA );
$VERSION = '1.24';
push @ISA, qw ( XML::Mini::Element );

sub new
    my $class = shift;
    my $self = {};
    bless $self, ref $class || $class;
    $self->{'_attributes'} = {};
    $self->{'_numChildren'} = 0;
    $self->{'_numElementChildren'} = 0;
    $self->{'_children'} = [];
    $self->{'_avoidLoops'} = $XML::Mini::AvoidLoops;
    return $self;

sub toString
    my $self = shift;
    my $depth = shift;
    if ($depth == $XML::Mini::NoWhiteSpaces)
	return $self->toStringNoWhiteSpaces();
    my $spaces = $self->_spaceStr($depth);
    my $retString = "$spaces<!-- \n";
    if (! $self->{'_numChildren'})
	$retString .= " -->\n";
	return $retString;
    my $nextDepth = $depth + 1;
    for (my $i=0; $i < $self->{'_numChildren'}; $i++)
	$retString .= $self->{'_children'}->[$i]->toString($nextDepth);
    $retString .= "\n" unless ($retString =~ m|\n$|sm);
    $retString .= "$spaces -->\n";
    return $retString;

sub toStringNoWhiteSpaces
    my $self = shift;
    my $retString = '<!-- ';
    if (! $self->{'_numChildren'})
	$retString .= ' -->';
	return $retString;
    for (my $i=0; $i < $self->{'_numChildren'}; $i++)
	$retString .= $self->{'_children'}->[$i]->toStringNoWhiteSpaces();
    $retString .= " -->";
    return $retString;



=head1 NAME



The XML::Mini::Element::Comment is used internally to represent <!-- comments -->.

You shouldn't need to use it directly, see XML::Mini::Element's comment() method.

=head1 AUTHOR

Copyright (C) 2002-2008 Patrick Deegan, Psychogenic Inc.

Programs that use this code are bound to the terms and conditions of the GNU GPL (see the LICENSE file). 
If you wish to include these modules in non-GPL code, you need prior written authorisation 
from the authors.

This library is released under the terms of the GNU GPL version 3, making it available only for 
free programs ("free" here being used in the sense of the GPL, see for more details). 
Anyone wishing to use this library within a proprietary or otherwise non-GPLed program MUST contact to 
acquire a distinct license for their application.  This approach encourages the use of free software 
while allowing for proprietary solutions that support further development.

=head2 LICENSE

    XML::Mini::Element module, part of the XML::Mini XML parser/generator package.
    Copyright (C) 2002-2008 Patrick Deegan
    All rights reserved
    XML::Mini is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    XML::Mini is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with XML::Mini.  If not, see <>.

Official XML::Mini site:

Contact page for author available on

=head1 SEE ALSO

XML::Mini, XML::Mini::Document, XML::Mini::Element