mouse::util(3pm) [debian man page]

Mouse::Util(3pm)					User Contributed Perl Documentation					  Mouse::Util(3pm)

NAME

       Mouse::Util - Utilities for working with Mouse classes

VERSION

       This document describes Mouse version 0.99

SYNOPSIS

	   use Mouse::Util; # turns on strict and warnings

DESCRIPTION

       This module provides a set of utility functions. Many of these functions are intended for use in Mouse itself or MouseX modules, but some
       of them may be useful for use in your own code.

IMPLEMENTATIONS FOR

   Moose::Util functions
       The following functions are exportable.

       "find_meta($class_or_obj)"

       The same as "Mouse::Util::class_of()".

       "does_role($class_or_obj, $role_or_obj)"

       "resolve_metaclass_alias($category, $name, %options)"

       "apply_all_roles($applicant, @roles)"

       "english_listi(@items)"

   Class::MOP functions
       The following functions are not exportable.

       "Mouse::Util::is_class_loaded($classname) -> Bool"

       Returns whether $classname is actually loaded or not.  It uses a heuristic which involves checking for the existence of $VERSION, @ISA, and
       any locally-defined method.

       "Mouse::Util::load_class($classname) -> ClassName"

       This will load a given $classname (or die if it is not loadable).  This function can be used in place of tricks like "eval "use $module
       ()"" or using "require".

       "Mouse::Util::class_of($classname_or_object) -> MetaClass"

       "Mouse::Util::get_metaclass_by_name($classname) -> MetaClass"

       "Mouse::Util::get_all_metaclass_instances() -> (MetaClasses)"

       "Mouse::Util::get_all_metaclass_names() -> (ClassNames)"

   mro (or MRO::Compat)
       "get_linear_isa"

   Sub::Identify
       "get_code_info"

Mouse specific utilities
       "not_supported"

       "get_code_package"

       "get_code_ref"

SEE ALSO

       Moose::Util

       Class::MOP

       Sub::Identify

       mro

       MRO::Compat

perl v5.14.2							    2012-06-30							  Mouse::Util(3pm)

Mouse::Meta::Class(3pm) 				User Contributed Perl Documentation				   Mouse::Meta::Class(3pm)

NAME

       Mouse::Meta::Class - The Mouse class metaclass

VERSION

       This document describes Mouse version 0.99

DESCRIPTION

       This class is a meta object protocol for Mouse classes, which is a subset of Moose::Meta:::Class.

METHODS

   "initialize(ClassName) -> Mouse::Meta::Class"
       Finds or creates a "Mouse::Meta::Class" instance for the given ClassName. Only one instance should exist for a given class.

   "name -> ClassName"
       Returns the name of the owner class.

   "superclasses -> ClassNames" "superclass(ClassNames)"
       Gets (or sets) the list of superclasses of the owner class.

   "add_method(name => CodeRef)"
       Adds a method to the owner class.

   "has_method(name) -> Bool"
       Returns whether we have a method with the given name.

   "get_method(name) -> Mouse::Meta::Method | undef"
       Returns a Mouse::Meta::Method with the given name.

       Note that you can also use "$metaclass->name->can($name)" for a method body.

   "get_method_list -> Names"
       Returns a list of method names which are defined in the local class.  If you want a list of all applicable methods for a class, use the
       "get_all_methods" method.

   "get_all_methods -> (Mouse::Meta::Method)"
       Return the list of all Mouse::Meta::Method instances associated with the class and its superclasses.

   "add_attribute(name => spec | Mouse::Meta::Attribute)"
       Begins keeping track of the existing Mouse::Meta::Attribute for the owner class.

   "has_attribute(Name) -> Bool"
       Returns whether we have a Mouse::Meta::Attribute with the given name.

   "get_attribute Name -> Mouse::Meta::Attribute | undef"
       Returns the Mouse::Meta::Attribute with the given name.

   "get_attribute_list -> Names"
       Returns a list of attribute names which are defined in the local class. If you want a list of all applicable attributes for a class, use
       the "get_all_attributes" method.

   "get_all_attributes -> (Mouse::Meta::Attribute)"
       Returns the list of all Mouse::Meta::Attribute instances associated with this class and its superclasses.

   "linearized_isa -> [ClassNames]"
       Returns the list of classes in method dispatch order, with duplicates removed.

   "new_object(Parameters) -> Instance"
       Creates a new instance.

   "clone_object(Instance, Parameters) -> Instance"
       Clones the given instance which must be an instance governed by this metaclass.

   "throw_error(Message, Parameters)"
       Throws an error with the given message.

SEE ALSO

       Mouse::Meta::Module

       Moose::Meta::Class

       Class::MOP::Class

perl v5.14.2							    2012-06-30						   Mouse::Meta::Class(3pm)