Maroš Kollár > MooseX-App-1.28 > MooseX::App::Message::Envelope

Download:
MooseX-App-1.28.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Source   Latest Release: MooseX-App-1.30

NAME ^

MooseX::App::Message::Envelope - Message presented to the user

DESCRIPTION ^

Whenever MooseX::App needs to pass a message to the user, it does so by generating a MooseX::App::Message::Envelope object. The object usually contains one or more blocks (MooseX::App::Message::Block) and can be easily stringified.

Usually a MooseX::App::Message::Envelope object is generated and returned by the new_with_command method in MooseX::App::Base if there is an error or if the user requests help.

To avoid useless object type checks when working with this method, MooseX::App::Message::Envelope follows the Null-class pattern. So you can do this, no matter if new_with_command fails or not:

 MyApp->new_with_command->some_method->only_called_if_successful;

METHODS ^

stringify

Stringifies the messages

add_block

Adds a new message block. Param must be a MooseX::App::Message::Block

list_blocks

Returns a list on message blocks.

blocks

Message block accessor.

OVERLOAD

Stringification of this object is overloaded.

AUTOLOAD

You can call any method on the message class.

syntax highlighting: