G. Wade Johnson > App-CmdDispatch-0.4 > App::CmdDispatch::IO

Download:
App-CmdDispatch-0.4.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.4   Source   Latest Release: App-CmdDispatch-0.42

NAME ^

App::CmdDispatch::IO - Abstract out the input and output for App::CmdDispatch

VERSION ^

This document describes App::CmdDispatch::IO version 0.4

SYNOPSIS ^

    use App::CmdDispatch::IO;

    my $io = App::CmdDispatch::IO->new;

    $io->print( "Message to the user\n" );

    my $name = $io->prompt( "What is your name: " );

DESCRIPTION ^

This class encapsulates the I/O interface needed by the App::CmdDispatch module. A user can replace this object to provide a different mechanism for interacting with the user.

This default version of the class defines the interface and interacts with the user through the standard in and out streams.

INTERFACE ^

The class supports a relatively small interface.

new()

Create a new object of type App::CmdDispatch::IO.

print( @strings )

Display the list of supplied strings to the user.

readline

Return a single line from the user.

prompt( @strings )

Display the list of supplied strings and then return a single line from the user.

CONFIGURATION AND ENVIRONMENT ^

App::CmdDispatch::IO requires no configuration files or environment variables.

DEPENDENCIES ^

Term::ReadLine

INCOMPATIBILITIES ^

None reported.

BUGS AND LIMITATIONS ^

No bugs have been reported.

AUTHOR ^

G. Wade Johnson wade@anomaly.org

LICENCE AND COPYRIGHT ^

Copyright (c) 2013, G. Wade Johnson wade@anomaly.org. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

DISCLAIMER OF WARRANTY ^

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

syntax highlighting: