WWW::USF::Directory::Exception::MethodArguments - Exception object for


WWW-USF-Directory documentation Contained in the WWW-USF-Directory distribution.

Index


Code Index:

NAME

Top

WWW::USF::Directory::Exception::MethodArguments - Exception object for exceptions that occur when bad arguments are provided to a method.

VERSION

Top

Version 0.003

SYNOPSIS

Top

  use WWW::USF::Directory::Exception::MethodArguments;

  WWW::USF::Directory::Exception::MethodArguments->throw(
      message  => 'This is some error message',
      argument => 'some_argument',
      method   => 'cool_method',
  );

DESCRIPTION

Top

This is an exception class for when a bad argument is provided to a method in the WWW::USF::Directory library.

INHERITANCE

Top

This class inherits from the base class of WWW::USF::Directory::Exception and all attributes and methods in that class are also in this class.

ATTRIBUTES

Top

argument

Required. This is a string that contains the name of the argument that contained a bad value.

argument_value

This is the bad value the argument had. This can be any type. Use has_argument_value to determine if the argument value is present.

has_argument_value

Whether or not the argument_value has been specified.

method

required

This is a string that contains the name of the method that was called and the the error occurred in.

METHODS

Top

This class does not contain any methods.

DEPENDENCIES

Top

* Moose 0.89
* MooseX::StrictConstructor 0.08
* WWW::USF::Directory::Exception
* namespace::clean 0.04

AUTHOR

Top

Douglas Christopher Wilson, <doug at somethingdoug.com>

BUGS AND LIMITATIONS

Top

Please report any bugs or feature requests to bug-www-usf-directory at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=WWW::USF::Directory. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

I highly encourage the submission of bugs and enhancements to my modules.

LICENSE AND COPYRIGHT

Top


WWW-USF-Directory documentation Contained in the WWW-USF-Directory distribution.

package WWW::USF::Directory::Exception::MethodArguments;

use 5.008001;
use strict;
use warnings 'all';

###########################################################################
# METADATA
our $AUTHORITY = 'cpan:DOUGDUDE';
our $VERSION   = '0.003';

###########################################################################
# MOOSE
use Moose 0.89;
use MooseX::StrictConstructor 0.08;

###########################################################################
# BASE CLASS
extends q{WWW::USF::Directory::Exception};

###########################################################################
# ALL IMPORTS BEFORE THIS WILL BE ERASED
use namespace::clean 0.04 -except => [qw(meta)];

###########################################################################
# ATTRIBUTES
has argument => (
	is  => 'ro',
	isa => 'Str',

	documentation => q{The argument that was invalid},
	required      => 1,
);
has argument_value => (
	is => 'ro',

	clearer       => '_clear_argument_value',
	documentation => q{The invalid value of the argument},
	predicate     => 'has_argument_value',
);
has method => (
	is  => 'ro',
	isa => 'Str',

	documentation => q{The method in which the error occurred},
	required      => 1,
);

###########################################################################
# MAKE MOOSE OBJECT IMMUTABLE
__PACKAGE__->meta->make_immutable;

1;

__END__