GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  MOOSEX::APP::MESSAGE::ENVELOPE (3)

.ds Aq ’

NAME

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

CONTENTS

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;



If

METHODS

    stringify

Stringifies the messages

    overload

This method is called whenever the object is stringified via overload. In this case it prints the message on either STDERR or STDOUT, and exits the process with the given exitcode (if any).

    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.

    exitcode

Exitcode accessor.

    has_exitcode

Check if exitcode is set.

    OVERLOAD

Stringification of this object is overloaded.

    AUTOLOAD

You can call any method on the message class.
Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 MOOSEX::APP::MESSAGE::ENVELOPE (3) 2015-04-30

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.