-
-
11 Aug 2011 02:55:56 UTC
- Distribution: Lucy
- Source (raw)
- Browse (raw)
- Changes
- How to Contribute
- Issues (1)
- Testers (3 / 16 / 0)
- Kwalitee
Bus factor: 1- License: apache_2_0
- Perl: v5.8.3
- Activity
24 month- Tools
- Download (1.02MB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
and 1 contributors- The Apache Lucy Project <lucy-dev at incubator dot apache dot org>
- Dependencies
- JSON::XS
- and possibly others
- Reverse dependencies
- CPAN Testers List
- Dependency graph
NAME
Clownfish::Parcel - Collection of code.
DESCRIPTION
A Parcel is a cohesive collection of code, which could, in theory, be published as as a single entity.
Clownfish supports two-tier manual namespacing, using a prefix, an optional class nickname, and the local symbol:
prefix_ClassNick_local_symbol
Clownfish::Parcel supports the first tier, specifying initial prefixes. These prefixes come in three capitalization variants: prefix_, Prefix_, and PREFIX_.
CLASS METHODS
singleton
Clownfish::Parcel->singleton( name => 'Crustacean', cnick => 'Crust', );
Add a Parcel singleton to a global registry. May be called multiple times, but only with compatible arguments.
name - The name of the parcel.
cnick - The C nickname for the parcel, which will be used as a prefix for generated global symbols. Must be mixed case and start with a capital letter. Defaults to
name
.
default_parcel
$parcel ||= Clownfish::Parcel->default_parcel;
Return the singleton for default parcel, which has no prefix.
OBJECT METHODS
get_prefix get_Prefix get_PREFIX
Return one of the three capitalization variants for the parcel's prefix.
acquire
$parcel = Clownfish::Parcel->aquire($parcel_name_or_parcel_object);
Aquire a parcel one way or another. If the supplied argument is a Parcel, return it. If it's not defined, return the default Parcel. If it's a name, invoke singleton().
get_name get_cnick
Accessors.
Module Install Instructions
To install Lucy::Simple, copy and paste the appropriate command in to your terminal.
cpanm Lucy::Simple
perl -MCPAN -e shell install Lucy::Simple
For more information on module installation, please visit the detailed CPAN module installation guide.