NAME

Meta::Ds::Enumerated - enumerated class.

COPYRIGHT

Copyright (C) 2001, 2002 Mark Veltzer; All rights reserved.

LICENSE

This program 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.

This program 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 this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.

DETAILS

        MANIFEST: Enumerated.pm
        PROJECT: meta
        VERSION: 0.03

SYNOPSIS

        package foo;
        use Meta::Ds::Enumerated qw();
        my($object)=Meta::Ds::Enumerated->new();
        my($result)=$object->method();

DESCRIPTION

This class is a base class for inheriting enumerated object which share a set of values from which they can be assigned.

FUNCTIONS

        new($)
        new_value($$)
        get_enum($)
        set($$)
        get($)
        TEST()

FUNCTION DOCUMENTATION

new($)

This is a constructor for the Meta::Ds::Enumerated object.

new_value($$)

This method will create a new variable initialized to a specific value.

get_enum()

This method is the method you should override. The method should return the Meta::Ds::Enum object which will be used to validate the values used in this type.

set($$)

This method will set the value of the variable.

get($)

This method will retrieve the value of the variable.

TEST()

This is a test suite for this object.

BUGS

None.

AUTHOR

        Name: Mark Veltzer
        Email: mark2776@yahoo.com
        WWW: http://www.geocities.com/mark2776
        CPAN id: VELTZER

HISTORY

        0.00 MV more thumbnail code
        0.01 MV thumbnail user interface
        0.02 MV import tests
        0.03 MV more thumbnail issues

SEE ALSO

Nothing.

TODO

Nothing.