Vincenzo Zocca > PerlBean-1.0 > PerlBean::Dependency::Import

Download:
PerlBean-1.0.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 1.0   Source  

NAME ^

PerlBean::Dependency::Import - Import dependency in a Perl bean

SYNOPSIS ^

TODO

ABSTRACT ^

Import dependency in a Perl bean

DESCRIPTION ^

PerlBean::Dependency::Import is a class to express import dependencies to classes/modules/files in a PerlBean.

CONSTRUCTOR ^

new( [ OPT_HASH_REF ] )

Creates a new PerlBean::Dependency::Import object. OPT_HASH_REF is a hash reference used to pass initialization options. On error an exception Error::Simple is thrown.

Options for OPT_HASH_REF may include:

import_list

Passed to set_import_list(). Must be an ARRAY reference.

Options for OPT_HASH_REF inherited through package PerlBean::Dependency may include:

dependency_name

Passed to set_dependency_name().

volatile

Passed to set_volatile().

METHODS ^

exists_import_list(ARRAY)

Returns the count of items in ARRAY that are in the list after the dependency_name.

get_dependency_name()

This method is inherited from package PerlBean::Dependency. Returns the dependency name.

get_import_list( [ INDEX_ARRAY ] )

Returns an ARRAY containing the list after the dependency_name. INDEX_ARRAY is an optional list of indexes which when specified causes only the indexed elements in the ordered list to be returned. If not specified, all elements are returned.

is_volatile()

This method is inherited from package PerlBean::Dependency. Returns whether the dependency is volatile or not.

pop_import_list()

Pop and return an element off the list after the dependency_name. On error an exception Error::Simple is thrown.

push_import_list(ARRAY)

Push additional values on the list after the dependency_name. ARRAY is the list value. On error an exception Error::Simple is thrown.

set_dependency_name(VALUE)

This method is inherited from package PerlBean::Dependency. Set the dependency name. VALUE is the value. On error an exception Error::Simple is thrown.

VALUE must match regular expression:
^.*[a-zA-Z].*$
set_idx_import_list( INDEX, VALUE )

Set value in the list after the dependency_name. INDEX is the integer index which is greater than or equal to 0. VALUE is the value.

set_import_list(ARRAY)

Set the list after the dependency_name absolutely. ARRAY is the list value. On error an exception Error::Simple is thrown.

set_num_import_list( NUMBER, VALUE )

Set value in the list after the dependency_name. NUMBER is the integer index which is greater than 0. VALUE is the value.

set_volatile(VALUE)

This method is inherited from package PerlBean::Dependency. State that the dependency is volatile. VALUE is the value. On error an exception Error::Simple is thrown.

shift_import_list()

Shift and return an element off the list after the dependency_name. On error an exception Error::Simple is thrown.

unshift_import_list(ARRAY)

Unshift additional values on the list after the dependency_name. ARRAY is the list value. On error an exception Error::Simple is thrown.

write(FILEHANDLE)

This method is an implementation from package PerlBean::Dependency. Writes code for the dependency. FILEHANDLE is an IO::Handle object.

SEE ALSO ^

PerlBean, PerlBean::Attribute, PerlBean::Attribute::Boolean, PerlBean::Attribute::Factory, PerlBean::Attribute::Multi, PerlBean::Attribute::Multi::Ordered, PerlBean::Attribute::Multi::Unique, PerlBean::Attribute::Multi::Unique::Associative, PerlBean::Attribute::Multi::Unique::Associative::MethodKey, PerlBean::Attribute::Multi::Unique::Ordered, PerlBean::Attribute::Single, PerlBean::Collection, PerlBean::Dependency, PerlBean::Dependency::Require, PerlBean::Dependency::Use, PerlBean::Described, PerlBean::Described::ExportTag, PerlBean::Method, PerlBean::Method::Constructor, PerlBean::Method::Factory, PerlBean::Style, PerlBean::Symbol

BUGS ^

None known (yet.)

HISTORY ^

First development: March 2003 Last update: September 2003

AUTHOR ^

Vincenzo Zocca

COPYRIGHT ^

Copyright 2003 by Vincenzo Zocca

LICENSE ^

This file is part of the PerlBean module hierarchy for Perl by Vincenzo Zocca.

The PerlBean module hierarchy is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

The PerlBean module hierarchy is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with the PerlBean module hierarchy; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

syntax highlighting: