1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
|
package Git::Raw::Tree::Builder;
$Git::Raw::Tree::Builder::VERSION = '0.87';
use strict;
use warnings;
use Git::Raw;
=head1 NAME
Git::Raw::Tree::Builder - Git tree builder class
=head1 VERSION
version 0.87
=head1 DESCRIPTION
A L<Git::Raw::Tree::Builder> allows you to build Git tree objects.
B<WARNING>: The API of this module is unstable and may change without warning
(any change will be appropriately documented in the changelog).
=head1 METHODS
=head2 new( $repo, [$tree] )
Creates a new tree builder that will build trees in C<$repo>. If C<$tree> is
passed, the contents of the tree builder are initialized from the contents of
C<$tree>.
=head2 clear( )
Clears the tree builder of all entries.
=head2 entry_count( )
Returns the number of entries contained in this tree builder.
=head2 get( $filename )
Return a L<Git::Raw::TreeEntry> corresponding to C<$filename>.
Returns C<undef> if no such entry exists.
=head2 insert( $filename, $object, $mode )
Adds (or updates) an entry in this tree builder. C<$object>
can be either a L<Git::Raw::Tree> or L<Git::Raw::Blob> object.
Returns a L<Git::Raw::Tree::Entry> object on success.
=head2 remove( $filename )
Removes the entry associated with the filename C<$filename> from this tree
builder.
=head2 write( )
Writes the tree object we've been building into the repository.
Returns a L<Git::Raw::Tree> object on success.
=head1 AUTHOR
Rob Hoelz <rob@hoelz.ro>
=head1 LICENSE AND COPYRIGHT
Copyright 2012 Alessandro Ghedini.
This program is free software; you can redistribute it and/or modify it
under the terms of either: the GNU General Public License as published
by the Free Software Foundation; or the Artistic License.
See http://dev.perl.org/licenses/ for more information.
=cut
1; # End of Git::Raw::Tree::Builder
|