lib/POE/Component/Client/MPD/Item/Directory.pm

   1 #
   2 # This file is part of POE::Component::Client::MPD.
   3 # Copyright (c) 2007 Jerome Quelin, all rights reserved.
   4 #
   5 # This program is free software; you can redistribute it and/or modify
   6 # it under the same terms as Perl itself.
   7 #
   8 #
   9
  10 package POE::Component::Client::MPD::Item::Directory;
  11
  12 use strict;
  13 use warnings;
  14
  15 use base qw[ Class::Accessor::Fast POE::Component::Client::MPD::Item ];
  16 __PACKAGE__->mk_accessors( qw[ directory ] );
  17
  18 #our ($VERSION) = '$Rev: 5645 $' =~ /(\d+)/;
  19
  20 1;
  21
  22 __END__
  23
  24 =head1 NAME
  25
  26 POE::Component::Client::MPD::Item::Directory - a directory object
  27
  28
  29 =head1 SYNOPSIS
  30
  31     print $item->directory . "\n";
  32
  33
  34 =head1 DESCRIPTION
  35
  36 C<POE::Component::Client::MPD::Item::Directory> is more a placeholder for a
  37 hash ref with one pre-defined key, namely the directory name.
  38
  39
  40 =head1 PUBLIC METHODS
  41
  42 This module only has a C<new()> constructor, which should only be called by
  43 C<POE::Component::Client::MPD::Item>'s constructor.
  44
  45 The only other public method is an accessor: directory().
  46
  47
  48 =head1 SEE ALSO
  49
  50 For all related information (bug reporting, mailing-list, pointers to
  51 MPD and POE, etc.), refer to C<POE::Component::Client::MPD>'s pod,
  52 section C<SEE ALSO>
  53
  54
  55 =head1 AUTHOR
  56
  57 Jerome Quelin, C<< <jquelin at cpan.org> >>
  58
  59
  60 =head1 COPYRIGHT & LICENSE
  61
  62 Copyright (c) 2007 Jerome Quelin, all rights reserved.
  63
  64 This program is free software; you can redistribute it and/or modify
  65 it under the same terms as Perl itself.
  66
  67 =cut